Roles

Update role

Changed on

Update a role

<div> <code>update:roles</code> </div>
patch/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.

Request body

namestring required

The role's name.

descriptionstring

The role's description.

keystring required

The role identifier to use in code.

is_default_roleboolean

Set role as default for new users.

assignment_permission_idstring uuid nullable

The public ID of the permission required to assign this role to users. If null, no change to the assignment permission is made. If set to 'NO_PERMISSION_REQUIRED', no permission is required.

Response

Role successfully updated

messagestring
codestring

Example response

{
  "message": "Success",
  "code": "OK"
}

Changes

  • 0c5023c4d856Revision changes
    • info

      added the new optional request property

  • 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