API ReferenceUser Role

Retrieve UserRoles

Retrieves the list of UserRoles defined within this Workspace.

A UserRole is a name for a privilege level granted to a specific User. The ‘Global Admin’ UserRole is granted to the owner of the Workspace, and this UserRole cannot be changed. You can choose which UserRole applies to a User within your Workspace.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-integration-namestringOptional

The name of the calling system passed along as a header parameter

Response

Success

errorobjectOptional

If the API call failed, this will contain information about the error that occurred.

successbooleanOptional

True if the API call succeeded; false otherwise.

hasErrorbooleanOptional

True if the API call failed.

statusCodeenumOptional

The HTTP code of the response.

datalist of objectsOptional

If the API call succeeded, this will contain the results.