Rename a custom Role or replace its Grants
Requires ac:update; replacing the Grants of a Role that grants, or would grant, organization:delete also requires organization:delete. Grants, when present, replace every Grant of the Role. Built-in Roles cannot change (409).
/organizations/{organizationId}/roles/{roleId}AuthorizationBearer token (JWT) · headerrequiredAn access token issued by this service (RFC 9068), in the Authorization header as Bearer <token>.
organizationIdstring<uuid>requiredroleIdstring<uuid>requiredapplication/jsonnamestringTrimmed and lower-cased; 1 to 64 characters, not a built-in name.
grantsgrant_documentA Role's Grants as scoped statements. Statements add together. Responses are canonical, one statement per scope instance.
Show propertiesHide properties
versionintegerrequired1statementsgrant_statement[]requiredShow propertiesHide properties
grant_statementscopegrant_scoperequiredThe organization, every instance of a project, cluster or integration type (all), or selected instances (ids).
Show propertiesHide properties
typescope_typerequiredorganizationprojectenvironmentclusterintegrationidsstring<uuid>[]allbooleanpermissionsstring[]requiredPermissions compatible with the scope, as resource:action.
The updated Role.
idstring<uuid>requirednamestringrequiredbuiltinbooleanrequiredBuilt-in Roles (owner, admin, member) cannot be renamed, edited or deleted.
grantsgrant_documentrequiredA Role's Grants as scoped statements. Statements add together. Responses are canonical, one statement per scope instance.
Show propertiesHide properties
versionintegerrequired1statementsgrant_statement[]requiredShow propertiesHide properties
grant_statementscopegrant_scoperequiredThe organization, every instance of a project, cluster or integration type (all), or selected instances (ids).
Show propertiesHide properties
typescope_typerequiredorganizationprojectenvironmentclusterintegrationidsstring<uuid>[]allbooleanpermissionsstring[]requiredPermissions compatible with the scope, as resource:action.
created_atstring<date-time>requiredThe request failed.
errorstringrequiredStable machine-readable code.
invalid_requestunauthorizedforbiddennot_foundconflictgoneunavailableinternalmessagestringrequiredHuman-readable explanation.