Skip to main content
PATCH
Update a user

Authorizations

x-api-key
string
header
required

Headers

x-idempotency-key
string<uuid>
required

Unique key (UUID) to ensure request idempotency on POST, PUT and PATCH requests.

A key is scoped to your client, the HTTP method and the path, and is remembered for 24 hours after a successful (below 400) response. Repeating the same request (same JSON body, whatever the key order or whitespace) with the same key within that window returns the original response with X-Idempotent-Replayed: true instead of executing the request again. Using the same key on the same endpoint with a different body returns 422 with problem type idempotency-key-reused; the request is not executed. Error responses (4xx and 5xx) are not remembered, so a request refused for a fixable reason can be corrected and retried under the same key. Request bodies that are not JSON (for example file uploads) are not compared.

Path Parameters

user_id
string
required

Unique identifier of the user to update KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27
Pattern: ^[0-9A-Za-z]{27}$
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

Body

application/json

Updated user details

Request body for updating a client user

first_name
string

Given name of the user

Minimum string length: 1
Example:

"John"

last_name
string

Surname of the user

Minimum string length: 1
Example:

"Doe"

role
enum<string>

Role that can be assigned to a client user. Available roles: admin (full access except issuances) and viewer (read-only access).

Available options:
admin,
viewer
Example:

"admin"

Response

user updated successfully