This page is no longer maintained (29 Mar 2023). For the most current information, go to https://docs.snaplogic.com/public-apis/post-users.html.

`POST /users`

Overview

This API creates a user.

Prerequisites

You need:

Org Admin permissions.

Request

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

Path Parameters

Key

Description

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

Query Parameters

None.

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" : ...,
  "allow_password_login" : ...,
  "utility" : ...,
  "ui_access" : ...,
  "create_home_directory" : ...,
  "email_notification" : ...,
  "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 Org to assign the user to.
`administrator`	Boolean	If `true`, the user is assigned as an Org administrator.
`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

POST /users