Tenant - Onboard users of an existing tenant
Authorizations
Path parameters
tenantIdstring · uuidRequired
Expects Id of an existing tenant
Query parameters
versionstringOptionalDefault:
The requested API version
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 · enumOptionalPossible values:
Enum for tenant level roles.
Responses
200
Indicates successful onboard of the request workspace user to an existing tenant
404
Not Found
500
Server related error
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": "Success Message",
"statusCode": 200
}
Last updated