Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
User group model roles

Assign or update user group model role

Assign or update a model role for a user group. If the user group already has a role for the specified model, this endpoint will update it to the new role. All members of the user group will inherit this role.

Model roles control what actions user group members can perform on models and connections. To manage user groups, see the User group APIs.

post/v1/user-groups/{userGroupId}/model-roles

Path parameters

userGroupIdstring required

The ID of the user group to assign or update a model role for.

Request body

connectionIdstring uuid

The ID of the connection that the model belongs to:

  • Required if modelId is not provided
  • Optional if modelId is provided, as it will be inferred from the model
modelIdstring uuid

The ID of the model to assign the role for:

  • Optional when assigning CONNECTION_ADMIN or custom roles with CONNECTION_ADMIN as the base role
  • Required for other role types
roleNamestring required

The role to assign. Available roles include:

  • VIEWER - Can view the model
  • QUERIER - Can view and query the model
  • QUERY_TOPICS - Can query specific topics. Equivalent to Restricted Querier.
  • MODELER - Can edit and model the data
  • CONNECTION_ADMIN - Full administrative access to the connection
  • NO_ACCESS - No access to the model
  • Custom roles defined for your organization

Response

Model role assigned or updated successfully.

userGroupIdstring

The ID of the user group.

connectionIdstring uuid

The ID of the connection.

modelIdstring uuid

The ID of the model.

roleNamestring

The assigned role name.