/v1/permissionGroups/assignPermissionGroups
—
post

Assign one or more permission groups to one or more entities (users, collaborators, or agent tokens). This grants the entities all permissions contained within the assigned permission groups.

Path Parameters
Not Applicable
Request Headers
HttpEndpointRequestHeaders_AuthRequired_JsonContentType

FieldTypeRequiredDescription
AuthorizationstringYes

Access token

Example: Bearer <token>

Content-TypestringYes

HTTP JSON request content type

Example: application/json

Request Query
Not Applicable
Request Body
AssignPermissionGroupsEndpointParams

Parameters for assigning permission groups to entities

{
workspaceId?: string
entityId: string | Array<string>
permissionGroupId: string | Array<string>
}
200 — Response Headers
Not Applicable
200 — Response Body
Not Applicable
4XX or 5XX — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

4XX or 5XX — Response Body
EndpointErrorResult

Endpoint error result

{
errors?: Array<ExternalError>
}
ExternalError

{
message: string
}