Skip to main content
PATCH
/
users
/
{userId}
cURL
curl --request PATCH \
  --url https://api.cradl.ai/{basePath}/users/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "metadata": {},
  "roleIds": [
    "<string>"
  ],
  "name": "<string>",
  "description": "<string>"
}
'
{
  "updatedTime": "<string>",
  "metadata": {},
  "updatedBy": "<string>",
  "createdBy": "<string>",
  "name": "<string>",
  "createdTime": "<string>",
  "description": "<string>",
  "userId": "<string>",
  "roleIds": [
    "<string>"
  ],
  "profileId": "<string>",
  "status": "inactive"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Content-Type
string
required

Path Parameters

​
userId
string
required

Body

application/json
​
metadata
object
​
roleIds
string[]
Pattern: ^(cradl|las):role:[0-9A-Za-z-_]{1,32}$
​
name
string | null
Maximum string length: 4096
​
description
string | null
Maximum string length: 4096

Response

200 response

​
updatedTime
string | null
required
Pattern: ^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$
​
metadata
object
required
​
updatedBy
string | null
required
Maximum string length: 4096
​
createdBy
string
required
Maximum string length: 4096
​
name
string | null
required
Maximum string length: 4096
​
createdTime
string
required
Pattern: ^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$
​
description
string | null
required
Maximum string length: 4096
​
userId
string
required
Pattern: ^(cradl|las):user:[0-9A-Za-z-_]+$
​
roleIds
string[] | null
Pattern: ^(cradl|las):role:[0-9A-Za-z-_]{1,32}$
​
profileId
string | null
Pattern: ^(cradl|las):profile:[a-f0-9]{32}$
​
status
enum<string>
Available options:
inactive,
active,
invite_pending