roles

Replace role permissions

Changed on

Atomically replace all permissions on a role, named by id or by resource_type:action key. System roles enforce a minimum permission floor.

post/api/v1/roles/{id}/permissions

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

permission_idsstring[]
permission_keysstring[]

PermissionKeys names permissions as resource_type:action keys. They are added to PermIDs.

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

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security BearerAuth was added to the API