Site Home
API Reference
LoginTry for Free

Query Tenant Roles

get
https://{application_vanity_domain}/api/v1/tenants//roles
Path Params
string
required
length between 1 and 26

The ID of the tenant that the resource or action is scoped to.

Query Params
string
length ≥ 0
Defaults to ""

Query expression used to filter returned results in a query API call.

string

List of attributes that the results of a query should be sorted by along with their corresponding sort orders. The items that occur earlier in the list will have higher sorting precedence than those that occur later in the list.

number
≥ 1
Defaults to 1

A 1-based index indicating the position of the first item that should be returned in the query response.

number
≥ 0
Defaults to 20

The maximum number of results that can be returned in a query response. If the value is set to 0 then the items array in the response will be empty; however the total results will still be set so you can see how many items this query matched.

string
length ≥ 0
Defaults to *

List of resource fields that should be returned in a response. The wildcard value of * can be used to return all fields for the resource.

boolean
Defaults to false

Boolean indicating if predefined roles should be returned in the result set. If set to true, only predefined roles that meet the following criteria will be returned:

  • Tenant visibility for the role is ALL.
  • Tenant visibility for the role is TENANT_INCLUSION_LIST and the inclusion list includes the tenant that the query is scoped to.
boolean
Defaults to false

Boolean indicating if the tenant's corresponding application roles should be returned in the result set. If set to true, application roles will be returned if they meet the following criteria:

  • Tenant visibility for the role is ALL.
  • Tenant visibility for the role is TENANT_INCLUSION_LIST and the inclusion list includes the tenant that the query is scoped to.
Responses

Updated 6 months ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago