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.

note

This endpoint is an alpha feature and may be subject to change in future releases.

Request

Path Parameters

userKey int64required

The key of the userKey of the authorization.

application/json

Body

required

sort object[]
Array [
field stringrequired
order string
Default value: asc
]
page object
from int32
limit int32
searchAfter object[]
searchBefore object[]
filter object

ownerType object

Possible values: [USER, ROLE, GROUP, MAPPING, UNSPECIFIED]

The type of the owner of permissions.

ownerKey int64

The id of the owner of permissions.

Responses

200

The user authorization search result.

application/json

Schema

Schema

page object
totalItems int64
firstSortValues object[]
lastSortValues object[]
items object[]
Array [
ownerKey int64
The id of the owner of permissions.
ownerType object
The type of the owner of permissions.
resourceType object
The type of resource to add/remove permissions to/from.
permissions object[]
The permissions.
Array [
permissionType object
Specifies the type of permissions.
resourceIds string[]
A list of resource IDs the permission relates to.
]
]

Example (from schema)

{
  "items": [
    {
      "ownerKey": 0,
      "permissions": [
        {
          "resourceIds": [
            "string"
          ]
        }
      ]
    }
  ],
  "page": {
    "totalItems": 0,
    "firstSortValues": [
      {}
    ],
    "lastSortValues": [
      {}
    ]
  }
}

400

The user authorization search query failed. More details are provided in the response body.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

An internal error occurred while processing the request.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...