Skip to main content
GET
/
authorization
Get Authorizations
curl --request GET \
  --url http://{host}:{port}/{contextPath}/authorization \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "anAuthorizationId",
    "type": 0,
    "permissions": [
      "ALL"
    ],
    "userId": "jonny1",
    "groupId": null,
    "resourceType": 1,
    "resourceId": "*"
  },
  {
    "id": "anotherAuthorizationId",
    "type": 0,
    "permissions": [
      "CREATE",
      "READ"
    ],
    "userId": "jonny2",
    "groupId": null,
    "resourceType": 1,
    "resourceId": "*",
    "removalTime": "2018-02-10T14:33:19.000+0200",
    "rootProcessInstanceId": "f8259e5d-ab9d-11e8-8449-e4a7a094a9d6"
  }
]

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

id
string

通过id筛选.

type
integer

Filter by authorization type. (0=global, 1=grant, 2=revoke). See the User Guide for more information about authorization types.

userIdIn
string

通过userIds筛选,半角逗号分隔.

groupIdIn
string

通过groupIds筛选,半角逗号分隔.

resourceType
integer

Filter by an integer representation of the resource type. See the User Guide for a list of integer representations of resource types.

resourceId
string

Filter by resource id.

sortBy
enum<string>

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

Available options:
resourceType,
resourceId
sortOrder
enum<string>

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Available options:
asc,
desc
firstResult
integer

Pagination of results. Specifies the index of the first result to return.

maxResults
integer

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

id
string | null

The id of the authorization.

type
integer | null

The type of the authorization (0=global, 1=grant, 2=revoke). See the User Guide for more information about authorization types.

permissions
string[] | null

An array of Strings holding the permissions provided by this authorization.

userId
string | null

The id of the user this authorization has been created for. The value * represents a global authorization ranging over all users.

groupId
string | null

The id of the group this authorization has been created for.

resourceType
integer | null

An integer representing the resource type. See the User Guide for a list of integer representations of resource types.

resourceId
string | null

The resource Id. The value * represents an authorization ranging over all instances of a resource.

removalTime
string<date-time> | null

The removal time indicates the date a historic instance authorization is cleaned up. A removal time can only be assigned to a historic instance authorization. Can be null when not related to a historic instance resource or when the removal time strategy is end and the root process instance is not finished. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

rootProcessInstanceId
string | null

The process instance id of the root process instance the historic instance authorization is related to. Can be null if not related to a historic instance resource.