Skip to main content
PATCH
/
api
/
v1
/
projects
/
{projectId}
/
identities
/
{identityId}
cURL
curl --request PATCH \
  --url https://us.infisical.com/api/v1/projects/{projectId}/identities/{identityId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "hasDeleteProtection": true,
  "metadata": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}'
{
  "identity": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "hasDeleteProtection": false,
    "activeLockoutAuthMethods": [
      "<string>"
    ],
    "authMethods": [
      "<string>"
    ],
    "metadata": [
      {
        "key": "<string>",
        "value": "<string>",
        "id": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

An access token in Infisical

Path Parameters

projectId
string
required

The ID of the project

identityId
string
required

The ID of the machine identity to update.

Body

application/json
name
string

The new name of the identity.

Minimum length: 1
hasDeleteProtection
boolean

Prevents deletion of the identity when enabled.

metadata
object[]

An optional array of key-value pairs to attach to the identity.

Response

Default Response

identity
object
required