Sign in
Roles

Get role

Changed on

Get a role

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

Request

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

Path parameters

role_idstring required

The identifier for the role.

Response

Role successfully retrieved.

codestring

Response code.

messagestring

Response message.

Example response

{
  "role": {
    "id": "01929904-316d-bb2c-069f-99dfea4ac394",
    "key": "admin",
    "name": "Administrator",
    "description": "Full access to all resources."
  }
}

Changes

  • 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

  • 6b937fa6da4eRevision changes
    • info

      endpoint added