PATCH
/
users
/
{userID}
Update a user
curl --request PATCH \
  --url https://backendapi.corbado.io/v2/users/{userID} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "fullName": "Jane Doe",
  "status": "pending"
}'
{
  "userID": "usr-4693224802260150919",
  "fullName": "Jane Doe",
  "status": "pending",
  "explicitWebauthnID": "<string>",
  "updated": "<string>",
  "updatedMs": 123
}

Authorizations

Authorization
string
header
required

Basic authentication is used to authenticate requests to the Backend API. The username is the project ID and the password is the API secret.

The project ID and API secret can be found in the Developer Panel.

Path Parameters

userID
string
required

Unique identifier of the user. Format: usr-<number>.

Example:

"usr-4693224802260150919"

Body

application/json
fullName
string
Example:

"Jane Doe"

status
enum<string>
Available options:
pending,
active,
disabled

Response

User has been updated.

userID
string
required
Example:

"usr-4693224802260150919"

status
enum<string>
required
Available options:
pending,
active,
disabled
updated
string
required
updatedMs
integer
required
fullName
string
Example:

"Jane Doe"

explicitWebauthnID
string