Sign in
Roles

Get role system permissions

Changed on

Get system permissions for a role.

System permissions control what organization users can do in the self-serve portal.

<div> <code>read:role_system_permissions</code> </div>
get/api/v1/roles/{role_id}/system_permissions

Request

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

Path parameters

role_idstring required

The role's public id.

Query parameters

sort'name_asc' | 'name_desc' | 'id_asc' | 'id_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

A list of system permissions for a role

codestring

Response code.

messagestring

Response message.

next_tokenstring nullable

Pagination token.

Example response

{
  "system_permissions": [
    {
      "id": "perm_019541f3fa0c874fc47b3ae73585b21c",
      "key": "org:read:billing",
      "name": "Read billing details",
      "description": "View plan and update card details"
    }
  ]
}

Changes