Tenant - Assigns tenant-level access to a user

Assigns tenant-level access to a user of the requested tenant based on the specified role.

POST/tenants/{tenantId}/users/{userId}/roles

Authorization

Bearer

Path parameters

tenantId*string (uuid)

Enter the ID of an existing tenant

userId*string (uuid)

Enter the ID of an existing user in requested tenant

Query parameters

Response

201404500

Success: Tenant-level role assigned to user successfully.

Body

text/plainapplication/jsontext/json

userIdstring (uuid)

A public property of type nullable Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the userId property.

tenantIdstring (uuid)

A public property of type nullable Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the tenantId property.

rolenullable string

A public property of type nullable Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the roleId property.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/tenants/{tenantId}/users/{userId}/roles?role=Viewer', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

201404500

{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "tenantId": "123e4567-e89b-12d3-a456-426614174000",
  "role": "text"
}