Roles and members

Change a custom role

A new version of the role. Every holder whose access shrinks goes through the reduction path. mail_scope follows the same rules as creating a role; a role whose stored scope cannot be read must be sent a new mail_scope, otherwise 400 validation_error with details.reason invalid_mail_scope. A personal mailbox the new version adds must be the author's own, and every holder must be the member of each personal mailbox it names: otherwise 403 grant_forbidden with details.reason personal_mailbox_member_only. Person only: a dashboard session, or the person's own OAuth or CLI token with a session step-up of purpose roles.write (the person confirms at the step_up_url a 403 step_up_required answer carries, which names this client, then send the token in the Primitive-Step-Up header; the token works only with the client it was confirmed for). Needs roles:assign. API keys are refused.

patch/roles/{id}

Request

  • Base URL
    https://api.primitive.dev/v1
  • URL
    https://api.primitive.dev/v1/roles/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The id of the group, role, member, grant or suspension the path names.

Request body

namestring
descriptionstring nullable
permissionsstring[]

Response

Change a custom role

successtrue required

Changes

No operation changes recorded.