Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

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

Redirect
filename
locationhttps://docs.snaplogic.com/public-apis/post-users.html

POST /users

Overview

This API creates a user.

...

Appsplus panel macro confluence macro
data{"features":["rounded"],"title":"","titleColor":"#FFFFFF","titleColorBG":"#0052CC","titleSize":16,"titleBold":false,"titleItalic":false,"titleUnderline":false,"link":"","linkIcon":false,"linkTab":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#dedede","borderColor":"#4C9AFF","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

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

...

None.

Request Header

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

Appsplus panel macro confluence macro
data{"features":["rounded"],"title":"","titleColor":"#FFFFFF","titleColorBG":"#0052CC","titleSize":16,"titleBold":false,"titleItalic":false,"titleUnderline":false,"link":"","linkIcon":false,"linkTab":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#dedede","borderColor":"#4C9AFF","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

Authorization: Basic {your_encoded_security_credentials}

Content-Type: application/json

Request Body

Code Block
{
  "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

Response

Response Header

...

Key

...

Description

...

X-SL-StatusCode

Status code indicating the results of the request.

...