curl --request PUT \
--url https://api.example.com/api/users/{userId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"status": "active",
"type": "invited",
"roles": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"type": "invited",
"status": "active",
"createdAt": "<string>",
"updatedAt": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"isService": true,
"roles": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>"
}
]
}Updates user properties including name, status, type, and assigned roles.
curl --request PUT \
--url https://api.example.com/api/users/{userId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"status": "active",
"type": "invited",
"roles": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"type": "invited",
"status": "active",
"createdAt": "<string>",
"updatedAt": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"isService": true,
"roles": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>"
}
]
}Unique identifier of the user to update
Updated first name
Updated last name
Updated user status
active, disabled, locked Updated user type
invited, member, author, admin, owner List of role IDs to assign to the user
Role ID
The updated user
The updated user
Unique identifier of the user
Email address of the user
User type/role within the organisation
invited, member, author, admin, owner Current status of the user account
active, disabled, locked Timestamp when the user was created
Timestamp when the user was last updated
First name of the user
Last name of the user
Whether this is a service account
Roles assigned to the user
Show child attributes
Was this page helpful?