Update an identity

Update an identity.

PUT https://api.jsonpad.io/identities/{identityId}

Example

1234567

curl https://api.jsonpad.io/identities/1056ae17-0d3e-477c-9a21-f5ca9d020c14 \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>" \
  -d '{
        "name": "My Updated Identity"
      }'

Parameters

required
identityIdstringAn identity id.

Request headers

required
x-api-tokenstringYour API token.

Request body

{group: "sample-group"
name: "Sample Identity"
password: "new-secret"
activated: true
}

optional
groupstringThe identity's group. This can be used to associate identities with a particular app or project, and helps to avoid name conflicts.
optional
namestringThe name of the identity.
optional
passwordstring
The identity's password.
optional
activatedbooleanWhether the identity is activated. Inactive identities cannot login and are not accessible via the API.

Response body

200 OK

{id: "dfc9b11e-b469-4af0-9aae-2436483fb3e5"
createdAt: "2026-09-05T11:30:38.056Z"
updatedAt: "2026-09-05T11:30:38.056Z"
user: {id: "a187e4fc-8e5d-462b-99a0-305d1aaa1640"
createdAt: "2026-09-05T11:30:38.056Z"
updatedAt: "2026-09-05T11:30:38.056Z"
lastActiveAt: "2026-09-05T11:30:38.056Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
name: "Sample Identity"
group: "sample-group"
activated: true
}

Response headers

last-modified2026-09-05T11:30:38.056ZThe date this identity was last modified.

2024-10-29