Add a user and send email notification
PUT /users/<email>/org/<organization>
Overview
This API adds and sends an email notification when an existing user is added to an Env/Org.
Prerequisites
- Environment (Org) admin permissions
Request
PUT https://{controlplane_path}/api/1/rest/public/users/<email>/org/<organization>
Path Parameters
Key | Description |
---|---|
controlplane_path |
Required. The path to the SnapLogic control plane. Example:
For other control planes, substitute the subdomain name for elastic . For
example:
|
email |
Required. The email address of the user. |
Query Parameters
Key | Type | Description |
---|---|---|
organization |
string | The name of the organization. |
Request Header
Specify Basic
for authorization and application/json
for content type.
Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json
Request Body
{
"create_home_directory": true
"send_email": true
}
Key | Type | Description |
---|---|---|
create_home_directory |
boolean | If true , the user's home directory is created. |
send_email |
boolean | If true , the notification email is sent. |
Response
Response Body
{
"email": "..."
"first_name": "...",
"last_name": "...",
"allow_password_login" : true,
"organizations": [
{
"id": "...",
"name": "...",
"administrator": "..."
}
],
"created_by": "...",
"password_expired": false,
"ui_access": true,
"password_last_updated": "...",
"user_locked_out": false,
"service_account": false,
"failed_logins": 0,
"basic_access": null,
"maintainers": null,
"managed": false
}
Key | Type | Description |
---|---|---|
email |
string | The email address of the user. |
first_name |
string | The first name of the user. |
last_name |
string | The last name of the user. |
allow_password_login |
Boolean | If true , the user is allowed to log in with a password.
|
organizations |
array |
An array of objects containing information about the Environments/Orgs that the user belongs to. Each object contains name and id of the Environment/Org and a Boolean (administrator) that indicates whether the user is assigned the administrator role in the Environment/Org. |
created_by |
string | The user who originally created the account, if it is a service account.
Learn more: Creating a User |
ui_access |
Boolean | If true , the user is granted access to the SnapLogic UI. |
password_expired |
boolean | If true , the user's password is expired. |
password_last_updated |
string | When the user's password was last changed. Format: UTC |
user_locked_out |
boolean | If true , the user is denied access to the Snaplex. |
service_account |
boolean | If true the user has a service account. |
failed_logins |
integer | The number of login attempts that failed. |
basic_access |
string | Format: UTC |
maintainers |
N/A | |
managed |
N/A |
Error Handling
HTTP Status Codes | Status | Description | Resolution |
---|---|---|---|
200 |
successful |
An array of objects that user is successfully added to Org. | N/A |
400 |
Bad request |
The request was unacceptable, often due to missing a required parameter. |
|