Query user authorizations (alpha)
POST/users/:userKey/authorizations/search
Search for user authorizations based on given criteria.
Note that this endpoint is an alpha feature and not enabled on Camunda clusters out of the box. The Camunda 8 API (REST) Overview page provides further details.
This endpoint is an alpha feature and may be subject to change in future releases.
Request
Path Parameters
The key of the userKey of the authorization.
- application/json
Body
required
- Array [
- ]
sort object[]
Default value: asc
page object
filter object
Possible values: [USER
, ROLE
, GROUP
, MAPPING
, UNSPECIFIED
]
The type of the owner of permissions.
The id of the owner of permissions.
Responses
- 200
- 400
- 500
The user authorization search result.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
page object
items object[]
The id of the owner of permissions.
The type of the owner of permissions.
The type of resource to add/remove permissions to/from.
permissions object[]
The permissions.
Specifies the type of permissions.
A list of resource IDs the permission relates to.
{
"items": [
{
"ownerKey": 0,
"permissions": [
{
"resourceIds": [
"string"
]
}
]
}
],
"page": {
"totalItems": 0,
"firstSortValues": [
{}
],
"lastSortValues": [
{}
]
}
}
The user authorization search query failed. More details are provided in the response body.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
An internal error occurred while processing the request.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}