Team / Integrations /

Update workload identity

Updates a workload identity. For managed roles using automatic provider setup, installation of the cloud resources is triggered automatically unless `noInstall=true` is passed.

Required permission

Account > Cloud > WorkloadIdentities > Update

Path parameters

workloadIdentityId
string required
ID of the workload identity

Query parameters

noInstall
boolean
Skip automatic installation of cloud resources after create or update for managed roles. The workload identity will be left in the unapplied/outdated state.

Request body

{object}

description
string
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
spec
{object}
updatedAt
string
time of update
createdAt
string
time of creation

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

PATCH /v1/workload-identities/{workloadIdentityId}

PATCH /v1/teams/{teamId}/workload-identities/{workloadIdentityId}

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request PATCH \
  --data '{"spec":{"restrictions":{"projects":{"enabled":false},"tags":{"enabled":false,"matchCondition":"or"}}}}' \
  https://api.northflank.com/v1/workload-identities/{workloadIdentityId}

Example response

200 OK

Data about the workload identity.

JSON

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