Create a user

POST /users


This API creates a user.


  • Environment (Org) admin permissions


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

Path Parameters

Key Description
controlplane_path Required. The path to the SnapLogic control plane.


For other control planes, substitute the subdomain name for elastic. For example:

Query Parameters


Request Header

Specify Basic for authorization and application/json for content type.

Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json

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


Status code only.