Update Workspace Group
Update the role a group holds on a workspace. Other grants on the workspace, including other groups’ bindings and direct user memberships, are unaffected. Replaces whatever this group held on this workspace, including a custom role.
Authentication and permissions
Token requirements: User-based token (OAuth) or Organization-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
- Default request: With a user OAuth token, setting custom_role_id also requires Edit Workspace Settings on the workspace.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The built-in role this group's members get on the workspace. Required unless custom_role_id is set; then it may be omitted, and if given it must equal that custom role's base role. Other grants on the workspace — other groups' bindings and direct user memberships — are left untouched. One binding row carries exactly one grant, so a built-in role replaces whatever this group held on this workspace, including a custom role.
TEAM_USER_ROLE_UNSPECIFIED, TEAM_USER_ROLE_AGENT, TEAM_USER_ROLE_MANAGER, TEAM_USER_ROLE_BUILDER, TEAM_USER_ROLE_VIEWER, TEAM_USER_ROLE_CONTRIBUTOR, TEAM_USER_ROLE_DRAFTER, TEAM_USER_ROLE_READONLY_AGENT, TEAM_USER_ROLE_APP_BUILDER, TEAM_USER_ROLE_APP_VIEWER, TEAM_USER_ROLE_PERSONAL_TEAM_OWNER Composite identifier ({team_id}:{group_id}). Alternative to team_id + group_id.
Bind the group to one of this workspace's custom roles instead of a plain built-in role. The binding's role is pinned to the custom role's base role. Requires custom roles to be enabled for the organization.
Response
Success

