Authorization

Get Authorizations

Queries for a list of authorizations using a list of parameters. The size of the result set can be retrieved by using the Get Authorization Count method.

get/authorization

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/authorization
  • Auth: HTTP basic

Query parameters

idstring

Filter by the id of the authorization.

typeinteger

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

userIdInstring

Filter by a comma-separated list of userIds.

groupIdInstring

Filter by a comma-separated list of groupIds.

resourceTypeinteger

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

resourceIdstring

Filter by resource id.

sortBy'resourceType' | 'resourceId'

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

sortOrder'asc' | 'desc'

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.

firstResultinteger

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

maxResultsinteger

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.

idstring nullable

The id of the authorization.

typeinteger nullable

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

permissionsstring[] nullable

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

userIdstring nullable

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

groupIdstring nullable

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

resourceTypeinteger nullable

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

resourceIdstring nullable

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

removalTimestring date-time nullable

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.

rootProcessInstanceIdstring nullable

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.

Changes

No recorded changes to this operation across all 1 revision of this API.