Authorization

Perform an Authorization Check

Performs an authorization check for the currently authenticated user.

get/authorization/check

Request

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

Query parameters

permissionNamestring required

String value representing the permission name to check for.

resourceNamestring required

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

resourceTypeinteger required

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

resourceIdstring

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

userIdstring

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.

permissionNamestring nullable

Name of the permission which was checked.

resourceNamestring nullable

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

resourceIdstring nullable

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

authorizedboolean nullable

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

Changes

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