Skip to main content

UpdateRole modifies a custom role.

PATCH 
/api/v1/auth/roles/:id

Cannot update system roles.

Parameters​

  • id: Required, role to update
  • name: Optional, new name
  • description: Optional, new description
  • permission_ids: Optional, replace all permissions

Errors​

  • NOT_FOUND: Role does not exist
  • FAILED_PRECONDITION: Cannot modify system role
  • PERMISSION_DENIED: Caller lacks roles:write permission

Request​

Responses​

A successful response.