AuthRolesResource Resource

GET /authRoles

Returns a list of the auth roles configured in the system.

Request Parameters
name type description default
view query summary
Response Body
media type data type description
application/json ApiAuthRoleList (JSON) A list of auth roles.

POST /authRoles

Creates a list of auth roles.

Request Body
media type data type description
application/json ApiAuthRoleList (JSON) List of auth roles to create.
Response Body
media type data type description
application/json ApiAuthRoleList (JSON) Information about created auth roles.

GET /authRoles/metadata

Returns a list of the auth roles' metadata for the built-in roles.

Request Parameters
name type description default
view query summary
Response Body
media type data type description
application/json ApiAuthRoleMetadataList (JSON) A list of auth role metadata

DELETE /authRoles/{uuid}

Deletes an auth role from the system.

Request Parameters
name type description default
uuid path The uuid of the auth role to delete. n/a
Response Body
media type data type description
application/json ApiAuthRole (JSON) The details of the deleted auth role.

GET /authRoles/{uuid}

Returns detailed information about an auth role.

Request Parameters
name type description default
uuid path The auth role to read. n/a
Response Body
media type data type description
application/json ApiAuthRole (JSON) The auth role's information.

PUT /authRoles/{uuid}

Updates the given auth role's information.

Request Parameters
name type description default
uuid path Uuid of the auth role being updated. n/a
Request Body
media type data type description
application/json ApiAuthRole (JSON) The auth role information.
Response Body
media type data type
application/json ApiAuthRole (JSON)