Update an identity

Update an identity.

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

Example

1234567

curl https://api.jsonpad.io/identities/6edd2a00-bdd5-49d5-89bb-f12137a683b3 \
  -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"
displayName: "Sample Display Name"
tags: [0: "my-app"
]
email: "identity@example.com"
password: "correct-horse"
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
displayNamestring | nullA public name for the identity. Set this to null (or an empty string) to remove the display name.
optional
tagsstring[]
Tags for grouping related resources together, e.g. ["recipe-app", "production"].
Tags are stored lowercase and can only contain letters, numbers, hyphens and underscores. There can be up to 20 tags, each up to 50 characters long.
Setting tags replaces all of the existing tags, and an empty array removes them.
optional
emailstring | null
The identity's email address. Set this to null to remove it. A new email address is marked as not verified, and any password reset or email verification tokens that were sent to the old address stop working.
In user auth mode you can also set emailVerified.
optional
passwordstring
The identity's password.
New passwords must be at least 8 characters, and at most 72 bytes, long.
Setting a new password logs the identity out everywhere.
optional
activatedbooleanWhether the identity is activated. Inactive identities cannot login and are not accessible via the API.

Response body

200 OK

{id: "2ccabe19-9789-4e01-be6c-6116bf4db38d"
createdAt: "2026-09-23T21:08:45.903Z"
updatedAt: "2026-09-23T21:08:45.903Z"
user: {id: "c5a5f82c-d51e-4a88-a4ec-e255c4761dbe"
createdAt: "2026-09-23T21:08:45.903Z"
updatedAt: "2026-09-23T21:08:45.903Z"
lastActiveAt: "2026-09-23T21:08:45.903Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
name: "Sample Identity"
displayName: "Sample Display Name"
tags: [0: "my-app"
]
group: "sample-group"
activated: true
}

Response headers

last-modified2026-09-23T21:08:45.903ZThe date this identity was last modified.

2026-09-17