Get Single Authorization

Retrieves a single authorization by Id.

Method

GET /authorization/{id}

Parameters

Path Parameters

Name Description
id The id of the authorization to be retrieved.

Result

A JSON array with the following properties:

Name Value Description
id String The id of the authorization.
type Integer The type of the authorization. (0=global, 1=grant, 2=revoke).
permissions Array of Strings An array of strings representing the permissions assigned by this authentication.
userId String The id of the user this authorization has been created for. The value "\*" represents a global authorization ranging over all users.
groupId String The id of the group this authorization has been created for.
resourceType Integer An integer representing the resource type. See the User Guide for a list of integer representations of resource types.
resourceId String The resource Id. The value "\*" represents an authorization ranging over all instances of a resource.
links Object A JSON array containing links to interact with the resource. The links contain only operations that the currently authenticated user would be authorized to perform.

Response Codes

Code Media type Description
200 application/json Request successful.
404 application/json Authorization with given id does not exist. See the Introduction for the error response format.

Example

Request

GET /authorization/anAuthorizationId

Response

Status 200.

{"id":"anAuthorizationId",
 "type": 0,
 "permissions": ["CREATE", "READ"],
 "userId": "*",
 "groupId": null,
 "resourceType": 1,
 "resourceId": "*"}

On this Page: