REST Web API

For details on parameters and schemas, see the operations under the Authorization tag of your OpenAPI documentation.

Entities

AuthorizationGroup

Represents a group of users. See Groups.

AuthorizationGroupMember

Represents a member of an AuthorizationGroup. A member is either

a user with an unique identifier or
another AuthorizationGroup

See Groups.

AuthorizationResource

Represents an app resource uniquely identified by a resource class and a resource identifier. See Resource Action Grants.

AuthorizationResourceActionGrant

Represents a grant that entitles a user, or an AuthorizationGroup, or a dynamic group of users to perform an action on an AuthorizationResource. See Resource Action Grants.

AuthorizationAvailableResourceClassActions

Represents the set of available

resource item actions (like 'patch', 'delete', or 'read' item)
resource collection collection (like 'post' new resources)

for one resource class.

The 'manage' action is predefined and available for all resource items and collections. See Resource Action Grants.

Operations

`POST /authorization/groups`

Creates a new group.

relay:errorId	Status code	Description	relay:errorDetails	Example
`authorization:adding-group-failed`	500	The group could not be created.	`message`	`['message' => 'Error message']`
`authorization:group-invalid`	400	The group is invalid.	`<invalid attribute>`	`['name']`

`GET /authorization/groups`

Gets one page of groups the logged-in user is authorized to read.

Filters:

search: return only those groups that contain the specified string (case-insensitive).

relay:errorId	Status code	Description	relay:errorDetails	Example
`authorization:getting-group-collection-failed`	500	The groups could not be retrieved.	`message`	`['message' => 'Error message']`

`GET /authorization/groups/{identifier}`

Gets the group with the given identifier.

relay:errorId	Status code	Description	relay:errorDetails	Example
`authorization:getting-group-item-failed`	500	The group could not be retrieved.	`message`	`['message' => 'Error message']`

`DELETE /authorization/groups/{identifier}`

Deletes the group with the given identifier.

relay:errorId	Status code	Description	relay:errorDetails	Example
`authorization:removing-group-failed`	500	The group could not be removed.	`message`	`['message' => 'Error message']`

`POST /authorization/groups-members`

Adds a new group member to a group.

relay:errorId	Status code	Description	relay:errorDetails	Example
`authorization:adding-group-member-failed`	500	The group member could not be added.	`message`	`['message' => 'Error message']`
`authorization:group-member-invalid`	400	The group member is invalid.	`<invalid attribute>`	`['name']`

`GET /authorization/groups-members`

Gets one page of group members for a given group.

relay:errorId	Status code	Description	relay:errorDetails	Example
`authorization:getting-group-member-item-failed`	500	The group members could not be retrieved.	`message`	`['message' => 'Error message']`
`authorization:required-parameter-missing`	400	A required parameter is missing.	`groupIdentifier`	`['groupIdentifier']`
`authorization:group-not-found`	404	Group with given identifier was not found.	`groupIdentifier`	`['groupIdentifier']`

`GET /authorization/groups-members/{identifier}`

Gets the group member with the given identifier.

relay:errorId	Status code	Description	relay:errorDetails	Example
`authorization:getting-group-member-collection-failed`	500	The group member could not be retrieved.	`message`	`['message' => 'Error message']`

`DELETE /authorization/groups-members/{identifier}`

Deletes the group member with the given identifier.

relay:errorId	Status code	Description	relay:errorDetails	Example
`authorization:removing-group-member-failed`	500	The group member could not be removed.	`message`	`['message' => 'Error message']`

`GET /authorization/resources`

Gets one page of the resources, the logged-in user is authorized to read.

relay:errorId	Status code	Description	relay:errorDetails	Example
`authorization:getting-resource-collection-failed`	500	The resources could not be retrieved.	`message`	`['message' => 'Error message']`

`GET /authorization/resources/{identifier}`

Gets the resource with the given identifier.

relay:errorId	Status code	Description	relay:errorDetails	Example
`authorization:getting-resource-item-failed`	500	The resource could not be retrieved.	`message`	`['message' => 'Error message']`

`POST /authorization/resource-action-grants`

Creates a new grant to perform a given action on the given resource.

Parameters:

resourceClass: Only return grant for resources from the given resource class.

relay:errorId	Status code	Description	relay:errorDetails	Example
`authorization:adding-resource-action-grant-failed`	500	The grant could not be added.	`message`	`['message' => 'Error message']`
`authorization:resource-action-grant-invalid-action-missing`	400	The grant is invalid: action is missing.		`['action']`
`authorization:resource-action-grant-invalid-action-undefined`	400	The grant is invalid: action is undefined for the given resource class.		`['action']`

`GET /authorization/resource-action-grants`

Gets one page of the grants, the logged-in user is authorized to read.

relay:errorId	Status code	Description	relay:errorDetails	Example
`authorization:getting-resource-action-grant-collection-failed`	500	The grants could not be retrieved.	`message`	`['message' => 'Error message']`

`GET /authorization/resource-action-grants/{identifier}`

Gets the grant with the given identifier.

relay:errorId	Status code	Description	relay:errorDetails	Example
`authorization:getting-resource-action-grant-item-failed`	500	The grant could not be retrieved.	`message`	`['message' => 'Error message']`

`DELETE /authorization/resource-action-grants/{identifier}`

Deletes the grant with the given identifier.

relay:errorId	Status code	Description	relay:errorDetails	Example
`authorization:removing-resource-action-grant-failed`	500	The grant could not be removed.	`message`	`['message' => 'Error message']`

`GET /authorization/available-resource-class-actions/{identifier}`

Get the list of item and collection actions that are available for the given resource class.

`GET /authorization/available-resource-class-actions`

Get the lists of item and collection actions that are available for all given resource classes the logged-in user is authorized to see.

Relay Authorization Bundle Laravel Package

REST Web API

Entities

AuthorizationGroup

AuthorizationGroupMember

AuthorizationResource

AuthorizationResourceActionGrant

AuthorizationAvailableResourceClassActions

Operations

POST /authorization/groups

GET /authorization/groups

GET /authorization/groups/{identifier}

DELETE /authorization/groups/{identifier}

POST /authorization/groups-members

GET /authorization/groups-members

GET /authorization/groups-members/{identifier}

DELETE /authorization/groups-members/{identifier}

GET /authorization/resources

GET /authorization/resources/{identifier}

POST /authorization/resource-action-grants

GET /authorization/resource-action-grants

GET /authorization/resource-action-grants/{identifier}

DELETE /authorization/resource-action-grants/{identifier}

GET /authorization/available-resource-class-actions/{identifier}

GET /authorization/available-resource-class-actions