Skip to main content
PATCH
/
users
/
{id}
Update a user by ID
curl --request PATCH \
  --url https://{tenant_id}.hanko.io/admin/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "john_doe_123",
  "name": "John Doe",
  "given_name": "John",
  "family_name": "Doe",
  "picture": "<string>"
}
'
{
  "id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "webauthn_credentials": [
    {
      "id": "f9bebc04-b894-4018-bdb8-8b520a532fef",
      "public_key": "<string>",
      "attestation_type": "<string>",
      "aaguid": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "backup_eligible": true,
      "backup_state": true,
      "mfa_only": true,
      "name": "<string>",
      "transports": [
        "<string>"
      ],
      "last_used_at": "2023-11-07T05:31:56Z"
    }
  ],
  "emails": [
    {
      "id": "802df042-1ac2-496d-af81-6ace729ed055",
      "address": "jsmith@example.com",
      "is_verified": true,
      "is_primary": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "username": {
    "id": "8cbed467-554b-4d17-b23f-bce1b4f1db92",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "username": "john_doe_123"
  },
  "otp": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "password": {
    "id": "28a7206b-e789-435a-b87c-108e034135c2",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "identities": [
    {
      "id": "77f8d594-9765-4891-ab2b-f31a797b531d",
      "email_id": "d4095586-8318-4a40-a840-b4260496f85a",
      "provider_id": "<string>",
      "provider_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {
    "public_metadata": {
      "role": "admin"
    },
    "private_metadata": {
      "internal_id": "e6c19cfb-09a2-41e5-a908-e33193b7ca0a"
    },
    "unsafe_metadata": {
      "birthday": "2025-05-12"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your API key. Must only be used when using Hanko Cloud.

Path Parameters

​
id
string<uuid4>
required

ID of the user

Example:

"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c"

Body

application/json

Patch payload for updating a user.

Omitted properties are not changed.

​
username
string | null

Set a new username for the user.

Send null to remove the username.

Example:

"john_doe_123"

​
name
string | null

Set a new username for the user.

Send null to remove the name.

Example:

"John Doe"

​
given_name
string | null

Set a new given name for the user.

Send null to remove the given_name.

Example:

"John"

​
family_name
string | null

Set a new family name for the user.

Send null to remove the family_name.

Example:

"Doe"

​
picture
string<uri> | null

Set a new picture for the user. Must be a public URL accessible via HTTP/HTTPS. Must not contain credentials.

Send null to remove the picture.

Maximum string length: 2048

Response

Details about the user

​
id
string<uuid4>
required

The ID of the user

Example:

"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c"

​
created_at
string<date-time>
required

Time of creation of the user

​
updated_at
string<date-time>
required

Time of last update of the user

​
webauthn_credentials
object[]

List of registered Webauthn credentials

​
emails
object[]

List of emails associated to the user

​
username
object

The username of the user

​
otp
object
​
password
object

The password credential of a user

​
identities
object[]

A list of third party provider identities

​
metadata
object

User metadata