Create a user

POST https://{controlplane_path}/api/1/rest/public/users

Creates a user or a service account for the specified environment. A service account doesn't have access to the SnapLogic UI. Environment admins can also create user, team, and service accounts in Admin Manager.

Prerequisites

Environment (Org) admin permissions

Query parameters

None.

Request body

 {
  "email" : "...",
  "first_name" : "...",
  "last_name" : "...",
  "organization" : "...",
  "administrator" : true,
  "allow_password_login" : true,
  "utility" : true,
  "ui_access" : true,
  "create_home_directory" : true,
  "email_notification" : true,
  "certificate" : "...",
  "file_handle" : "..."
}


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.
`organization`	string	The Environment/Org to assign the user to.
`administrator`	Boolean	If `true`, the user is assigned as an Environment/Org admin.
`allow_password_login`	Boolean	If `true`, the user is allowed to log in with a password.
`utility`	Boolean	If `true`, the account is tagged as a service account, not a user account, for use with automated processes.
`ui_access`	Boolean	If `true`, the user is granted access to the SnapLogic UI.
`create_home_directory`	Boolean	If `true`, a home directory is created for the user.
`email_notification`	Boolean	If `true`, the user is sent a welcome email when the account is created.
`certificate`	string
`file_handle`	string

Note:

We recommend to set either the utility or ui_access attribute to true, but not both simultaneously.
- To create a service account, set the utility attribute to true.
- To grant access to the SnapLogic UI, set the ui_access attribute to true.
If the utility attribute is set to true, the ui_access attribute is automatically read as false, regardless of any value provided for ui_access in the request body while making the API call.

Response

Status code only.