Skip to navigation
DocumentationReferenceAPI ReferenceIAM

Create role binding

View as Markdown

Create a new role binding (Platform Admin only)

Query parameters

wait_role_propagationbooleanOptionalDefaults to true

If true, wait for role to propagate before returning (default: true). Set to false for bulk operations.

Request

This endpoint expects an object.
principalstringRequired<=256 characters

The principal identifier (email, user ID, or group ID)

rolestringRequired

The role name (e.g., ‘Viewer’, ‘Editor’, ‘Admin’)

workspacestringOptionalformat: "^[\w\-\+.@:]+$"

The workspace this binding applies to. None for platform-level roles.

Response

Successful Response
idstring
namestring
principalstring
workspacestring
rolestring
granted_bystring
granted_atdatetime
revoked_atdatetime

Errors

422
Unprocessable Entity Error