/v1/permissionGroups/updatePermissionGroup
—
post

Update an existing permission group's name or description. You can identify the permission group either by its ID or by providing the workspace ID and permission group name.

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
UpdatePermissionGroupEndpointParams

Parameters for updating an existing permission group

{
permissionGroupId?: string
name?: string
workspaceId?: string
data: UpdatePermissionGroupInput
}
UpdatePermissionGroupInput

Fields to update on the permission group

{
name?: string
description?: string
}
200 — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

Example: 1024

200 — Response Body
UpdatePermissionGroupEndpointResult

Response containing the updated permission group

{
permissionGroup: PermissionGroup
}
PermissionGroup

A permission group that can be assigned to entities to grant access to workspace resources

{
resourceId: string
createdBy: Agent
createdAt: number
lastUpdatedBy: Agent
lastUpdatedAt: number
isDeleted: boolean
deletedAt?: number
deletedBy?: Agent
workspaceId: string
name: string
description?: string
}
Agent

Represents a user or system entity that performed an action (e.g., created or updated a resource)

{
agentId: string
agentType: string
}
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
}