Roles

Get a role by name

Get a role by name.

get/v1/roles/name/{name}

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/roles/name/{name}
  • Auth: HTTP bearer

Path parameters

namestring required

Name of the role

Query parameters

fieldsstring
Example:policies,teams,users

Fields requested in the returned resource

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

Response

The role

idstring uuid required
namestring required
fullyQualifiedNamestring
displayNamestring
descriptionstring
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
hrefstring uri
allowDeleteboolean
allowEditboolean
deletedboolean
provider'system' | 'user' | 'automation'
disabledboolean
extensionobject
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
sourceHashstring

Changes

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