Sign in
Roles

List roles

Changed on

The returned list can be sorted by role name or role key in ascending or descending order. The number of records to return at a time can also be controlled using the page_size query string parameter.

<div> <code>read:roles</code> </div>
get/api/v1/roles

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/roles
  • Auth: HTTP bearer

Query parameters

sort'name_asc' | 'name_desc' | 'key_asc' | 'key_desc' nullable

Field and order to sort the result by.

page_sizeinteger nullable

Number of results per page. Defaults to 10 if parameter not sent.

next_tokenstring nullable

A string to get the next page of results if there are more results.

Response

Roles successfully retrieved.

codestring

Response code.

messagestring

Response message.

next_tokenstring

Pagination token.

Changes

  • bfffc845554dRevision changes
    • breaking

      removed the enum value id_asc from the query request parameter sort

    • breaking

      removed the enum value id_desc from the query request parameter sort

    • info

      added the new enum value key_asc to the query request parameter sort

    • info

      added the new enum value key_desc to the query request parameter sort

  • 2d09422a38e4Revision changes
    • breaking

      added the new required header request parameter Accept to all path's operations

    • info

      the endpoint scheme security kindeBearerAuth was added to the API

    • info

      the endpoint scheme security ManagementAPI was removed from the API