Tenant - Onboard users of an existing tenant

Onboards users of existing Tenant

POST/tenants/{tenantId}/users/onboard

Authorization

Bearer

Path parameters

tenantId*string (uuid)

Expects Id of an existing tenant

Query parameters

Body

application/jsontext/jsonapplication/*+json

Expects user details that have to be onboarded

userIdstring (uuid)

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.

tenantAccessenum

Enum for tenant level roles.

ViewerContributorOwnerExporter

Response

200404500

Indicates successful onboard of the request workspace user to an existing tenant

Body

text/plainapplication/jsontext/json

messagenullable string

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

statusCodeinteger (int32)

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

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/tenants/{tenantId}/users/onboard', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {}
    ]),
});
const data = await response.json();

Response

200404500

{
  "message": "Success Message",
  "statusCode": 200
}