Tenant - Onboards users to a tenant

Onboards users to an existing tenant with provided user details.

post

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Path parameters

tenantIdstring · uuidRequired

Enter the ID of an existing tenant

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Bodyobject[]

application/jsontext/jsonapplication/*+json

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.

Possible values:

Responses

200

Success: User onboarded successfully to an existing tenant.

text/plainapplication/jsontext/json

Class for representing response.

messagestring · nullableOptional

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.

Default: Success Message

statusCodeinteger · int32Optional

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.

Default: 200

404

Not Found: The requested tenant ID 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/onboard

HTTPcURLJavaScriptPython

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

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

application/jsontext/jsonapplication/*+json

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