Skip to main content
GET
/
authorization
/
check
Perform an Authorization Check
curl --request GET \
  --url http://{host}:{port}/{contextPath}/authorization/check \
  --header 'Authorization: Basic <encoded-value>'
{
  "permissionName": "READ",
  "resourceName": "USER",
  "resourceId": "jonny",
  "authorized": true
}

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

​
permissionName
string
required

String value representing the permission name to check for.

​
resourceName
string
required

String value for the name of the resource to check permissions for.

​
resourceType
integer<int32>
required

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

​
resourceId
string

The id of the resource to check permissions for. If left blank, a check for global permissions on the resource is performed.

​
userId
string

The id of the user to check permissions for. The currently authenticated user must have a READ permission for the Authorization resource. If userId is blank, a check for the currently authenticated user is performed.

Response

Request successful.

​
permissionName
string | null

Name of the permission which was checked.

​
resourceName
string | null

The name of the resource for which the permission check was performed.

​
resourceId
string | null

The id of the resource for which the permission check was performed.

​
authorized
boolean | null

Returns true or false depending on whether the user is authorized or not.