Tenant - Onboards users to a tenant

PreviousTenant - Onboards a workspace as a tenant NextTenant - Retrieves available workspaces for onboarding

Last updated 4 months ago

Onboards users to an existing tenant with provided user details.

post

Authorizations

Path parameters

tenantIdstring · uuidRequired

Enter the ID of an existing tenant

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Body

Class for storing details about users to be onboarded.

userIdstring · uuidOptional

A public property of type Guid that has both a getter and a setter method, which allows for getting and setting the value of the UserId property.

tenantAccessstring · enumOptional

Enum for tenant level roles.

Available options:

Responses

objectOptional

Class for representing response.

post

POST /tenants/{tenantId}/users/onboard HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 75

[
  {
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "tenantAccess": "Viewer"
  }
]

{
  "message": "text",
  "statusCode": 1
}