CommunityWebsiteDocumentationExchangeSupportDeveloper
HomeGuidesAPI Reference
CommunityWebsiteDocumentationExchangeSupportDeveloper
API Reference

List roles

get
https://{serverURL}/api/roles

Get a list of roles.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Search phrase for partial matches on name or description

int64
Defaults to 25

Maximum number of records to return

int64
Defaults to 0

Offset records, the number of records to skip, for paginating requests

string
Defaults to name

Sort order, the name of the property to sort by

string
enum
Defaults to asc

Sort direction, use 'desc' to reverse sort

Allowed:

Filter by one or more role IDs (integer or string forms accepted)

string

Filter by authority (exact match, case-insensitive)

string

Alias for authority

string

Filter by description (exact match, case-insensitive)

string
enum

Filter by roleType

Allowed:

Tenant/account ID whose roles to list. Master tenants may load a child tenant's roles. Alias of tenant. Integer or string accepted.

Alias for owner. Integer or string accepted.

Responses

Updated almost 3 years ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 3 years ago

Did this page help you?