roles

Update a role

Changed on

Update a role's name or description. System roles cannot be renamed.

patch/api/v1/roles/{id}

Request

  • The document declares no server URL.
  • Auth
    • API key in header X-API-Key
    • or API key in header Authorization

Path parameters

idstring required

Role ID

Request body

descriptionstring
namestring

Response

OK

created_atstring
deleted_atstring
descriptionstring
idstring
is_systemboolean
namestring
permission_keysstring[]

PermissionKeys are the same permissions as resource_type:action keys, the form a role document is written in.

updated_atstring
user_countinteger

Changes

  • 0bd802afff21Revision changes
    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security BearerAuth was added to the API