Team / Integrations /

Install workload identity

Triggers installation of the managed cloud resources (IAM role/policy) for a workload identity. For identities using an existing role, this validates and records the role details.

Required permission

Account > Cloud > WorkloadIdentities > Update

Path parameters

workloadIdentityId
string required
ID of the workload identity

Response body

{object}
Response object.

data
{object} required
Result data.

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

API

CLI

JS Client

POST /v1/workload-identities/{workloadIdentityId}/install

POST /v1/teams/{teamId}/workload-identities/{workloadIdentityId}/install

Example response

200 OK

Data about the workload identity after triggering installation.

JSON

{
  "data": {
    "id": "example-workload-identity",
    "name": "Example Workload Identity",
    "spec": {
      "restrictions": {
        "projects": {
          "enabled": false
        },
        "tags": {
          "enabled": false,
          "matchCondition": "or"
        }
      }
    }
  }
}