Team / Integrations /

List workload identities

Lists the workload identities saved to this account.

Required permission

Account > Cloud > WorkloadIdentities > Read

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
page
integer
The page number to access.
cursor
string
The cursor returned from the previous page of results, used to request the next page.

Response body

{object}
Response object.

data
{object} required
Result data.

workloadIdentities
[array]

{object}
An array of workload identities

id
string required
ID of the workload identity
min length
3
max length
39
pattern
^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$
name
string required
min length
3
max length
100
pattern
^[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*$
description
string
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
spec
{object} required
state
{object}
The current state of the workload identity.

status
string required
The current install status of the workload identity.
one of
unapplied, outdated, installing, error, applied, deleting
updatedAt
string
time of update
errors
[array]
Any errors encountered during installation.

string

updatedAt
string
time of update
createdAt
string
time of creation

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

API

CLI

JS Client

GET /v1/workload-identities

GET /v1/teams/{teamId}/workload-identities

Example response

200 OK

A list of workload identities saved to this account.

JSON

{
  "data": {
    "workloadIdentities": [
      {
        "id": "example-workload-identity",
        "name": "Example Workload Identity",
        "spec": {
          "restrictions": {
            "projects": {
              "enabled": false
            },
            "tags": {
              "enabled": false,
              "matchCondition": "or"
            }
          }
        }
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}