IAM API ReferenceUser

Update a user's roles

Update Organization and Workspace roles for a user.

Path parameters

organizationIdstringRequired
The ID of the Organization to which the user belongs.
userIdstringRequired
The user's ID

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
deploymentRoleslist of objectsOptional

The user’s updated Deployment roles. Requires also specifying an OrganizationRole.

organizationRoleenumOptional
The user's updated Organization role.
Allowed values:
workspaceRoleslist of objectsOptional

The user’s updated Workspace roles. Requires also specifying an OrganizationRole.

Response

The response body containing the user's roles
deploymentRoleslist of objects or null
A list of the subject's Deployment roles. Currently only for API tokens.
organizationRoleenum or null
The subject's Organization role.
Allowed values:
workspaceRoleslist of objects or null
A list of the subject's Workspace roles.

Errors