Set the permissions for a person
Grant the person the permissions specified in the request body, and revoke the person any other existing permissions. All permissions in the request body must already exist. Duplicate permissions in the request body will be ignored. If an empty list is supplied in the request body, the person will be revoked all permissions they currently have.
Path Parameters
- person_id string required
The person ID
Example: 903c1ff9-f2cc-435c-b242-9d8a690fcf0a
Header Parameters
- SlashID-OrgID string required
The organization ID
Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1 - If-Match string
The value of the
ETag
header from the GET response. If the value of theETag
header from the last response does not match the value of this header, the server will respond with a412 Precondition Failed
status code. If-Match is not required. If omitted, the server will not check theETag
header. - SlashID-Required-Consistency string
Possible values: [
local_region
,all_regions
]Default value:
local_region
The consistency level required for this request. If the consistency level is not achieved within the timeout, the request will fail with a 408 Request Timeout error. 408 Request Timeout error indicates that request was not handled within the timeout, but it may still be handled after request timeout. Allowed values: *
local_region
: Wait while the request executes in the local region. *all_regions
: Wait while the request executes across all regions. You can learn more about our replication model on our Cross-region Replication Model page. - SlashID-Required-Consistency-Timeout integer
Possible values:
>= 1
and<= 120
Default value:
30
The maximum amount of seconds to wait for the requested consistency level to be achieved. If the consistency level is not achieved within this time, the request will fail with a 408 Request Timeout error. 408 Request Timeout error indicates that request was not handled within the timeout, but it may still be handled after request timeout. You can learn more about our replication model on our Cross-region Replication Model page.
- application/json
Request Body required
- permissions string[] required
Possible values:
<= 1024 characters
, Value must match regular expression^[A-Za-z0-9]{1}[\w./\\\-:]*[A-Za-z0-9]$
- 204
- 400
- 404
- 412
No content
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
meta object
pagination object
limit integeroffset integertotal_count int64errors object[]
httpcode integermessage string
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
]
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
meta object
pagination object
limit integeroffset integertotal_count int64errors object[]
httpcode integermessage string
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
]
}
Precondition Failed
- application/json
- Schema
- Example (from schema)
Schema
meta object
pagination object
limit integeroffset integertotal_count int64errors object[]
httpcode integermessage string
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
]
}