v4

OpenAPI 3.1.02026-08-01207318738.7 KB
Users

Assign model role to user group

post/api/v1/user-groups/{id}/model-roles

Path parameters

idstring required

User group short identifier (miniUuid)

Example:abc123

User group short identifier (miniUuid)

Request body

connectionIdstring uuid

Connection ID for connection-level role assignment. Required if modelId not provided.

modelIdstring uuid

Model ID for model-level role assignment. Required if connectionId not provided.

roleNamestring required

Name of the role to assign (base or custom role)

Example request

{
  "connectionId": "550e8400-e29b-41d4-a716-446655440000",
  "modelId": "550e8400-e29b-41d4-a716-446655440000",
  "roleName": "VIEWER"
}

Response

Role assigned successfully

connectionIdstring uuid required

The connection ID for this role assignment

modelIdstring uuid required

The model ID for this role assignment

roleNamestring required

The assigned role name

userGroupIdstring required

The user group short identifier

Example response

{
  "roleName": "VIEWER",
  "userGroupId": "abc123"
}