For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get Started
Docs & GuidesAPI Reference
Docs & GuidesAPI Reference
  • Authentication
    • API Authentication
  • API Reference
      • POSTCreate Invitation
      • DELDelete Invitation
      • GETGet Invitation
      • GETList Invitations
      • GETList Roles
      • GETList Users
      • DELRemove User
      • PUTUpdate User Roles
Get Started
LogoLogo
API ReferenceUser Management

Update User Roles

PUT
https://api.coactive.ai/api/v1/auth-management/users/:user_id/roles
PUT
/api/v1/auth-management/users/:user_id/roles
$curl -X PUT https://api.coactive.ai/api/v1/auth-management/users/user_id/roles \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "roles": [
>    {
>      "role_id": "admin"
>    }
>  ],
>  "roles_context": "system"
>}'
1{
2  "user_id": "auth0|123",
3  "name": "John Doe",
4  "created_at": "2024-01-01T00:00:00Z",
5  "roles": [
6    {
7      "role_id": "admin"
8    }
9  ],
10  "email": "john@example.com",
11  "picture": "https://example.com/avatar.jpg",
12  "last_login": "2024-01-02T00:00:00Z"
13}
Replace a user's roles. This endpoint allows administrators to replace the roles assigned to a user. The roles can be scoped to a specific context (e.g., dataset or system). If a context is provided, the roles will only be replaced within that context. If no context is provided, all roles (system-level and dataset-level) will be replaced. To replace roles at the system level, use the "system" context. To replace roles at the dataset level, use the "dataset:{dataset_id}" context.
Was this page helpful?
Previous

Create a metadata value

Next
Built with

Replace a user’s roles.

This endpoint allows administrators to replace the roles assigned to a user.

The roles can be scoped to a specific context (e.g., dataset or system). If a context is provided, the roles will only be replaced within that context. If no context is provided, all roles (system-level and dataset-level) will be replaced.

To replace roles at the system level, use the “system” context. To replace roles at the dataset level, use the “dataset:{dataset_id}” context.

Authentication

AuthorizationBearer

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

Path parameters

user_idstringRequiredformat: "^auth0\|[A-Za-z0-9]+$"
The ID of the user to update

Request

This endpoint expects an object.
roleslist of objectsRequired
New list of roles to assign to the user
roles_contextstring or nullOptional

Context for the roles to update. This can either be ‘system’ for system-level roles or ‘dataset:{dataset_id}’ for dataset-level roles.

Response

The updated user profile with new roles
user_idstring
Unique identifier for the user
namestring
Display name of the user
created_atstringformat: "date-time"
Timestamp when the user was created
roleslist of objects
List of roles assigned to the user
emailstring or null
Email address of the user
picturestring or null
URL to the user's profile picture
last_loginstring or nullformat: "date-time"
Timestamp of the user's last login

Errors

422
Unprocessable Entity Error