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

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Path parameters

tenantIdstring · uuidRequired

Enter the ID of an existing tenant

userIdstring · uuidRequired

Enter the ID of an existing user in requested tenant.

Query parameters

rolestringRequired

Enter name of the tenant level role for fetching related users. Allowed value: Viewer, Contributor, Owner, Exporter.

versionstringOptional

The requested API version

Default: 1.0

Responses

201

Success: Tenant-level role assigned to user successfully.

text/plainapplication/jsontext/json

Class for represnting the Tenant admin details.

userIdstring · uuidOptional

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 · uuidOptional

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.

rolestring · nullableOptional

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.

404

Not Found: Indicates that the requested tenant does not exist.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

post

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

HTTPcURLJavaScriptPython

POST /tenants/{tenantId}/users/{userId}/roles?role=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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