Associate a user
POST /tenancy/account/{accountId}/associate
Associates the user to the account by using the user email.
Token usage: BlueXP user token.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
accountId |
string |
path |
True |
|
authorization |
string |
header |
True |
Authorization JWT access token |
X-User-Token |
string |
header |
False |
User JWT access token |
X-Service-Request-Id |
string |
header |
False |
Request identifier |
Request Body
Name | Type | Required | Description |
---|---|---|---|
associatedEmail |
string |
False |
User email to be associated with the account |
rolePublicId |
string |
False |
User role name. For example, use Role-1 for account admin or Role-2 for workspace admin. |
Example request
{
"associatedEmail": "string",
"rolePublicId": "Role-1"
}
Response
Status: 200, Default response
Name | Type | Required | Description |
---|---|---|---|
userPublicId |
string |
False |
|
userClientId |
string |
False |
|
userRole |
string |
False |
|
cloudManagerNotificationsOptIn |
boolean |
False |
Example response
{
"userPublicId": "string",
"userClientId": "string",
"userRole": "string"
}
Definitions
See Definitions
body
Name | Type | Required | Description |
---|---|---|---|
associatedEmail |
string |
False |
User email to be associated with the account |
rolePublicId |
string |
False |
User role name. For example, use Role-1 for account admin or Role-2 for workspace admin. |