Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
InfoThis topic is a work-in-progress.

POST /users

Overview

This API creates a user.

Prerequisites

You need:

  • Org Admin permissions.

Appsplus panel macro confluence macro
data{"features":["title","rounded"],"title":"In this page","titleColor":"#7a7a7a","titleColorBG":"#d4f7e4","titleSize":16,"titleBold":true,"titleItalic":false,"titleUnderline":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#7a7a7a","panelColorBG":"#e3fcef","borderColor":"#4C9AFF","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}
Table of Contents
minLevel1
maxLevel1
classtocsidebar

Request

Paste code macro
themeAscetic
POST http://{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 Auth for authorization.

Paste code macro
themeAscetic
Authorization: Basic {your_encoded_security_credentials}

Request Body

Paste code macro
themeAscetic
{
  "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 assigned as an Org administrator.

allow_password_login

Boolean

If true, ???

utility

Boolean

If true, ???

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, ???

certificate

string

???

file_handle

string

???

Response

Response Header

Key

Description

X-SL-StatusCode

Status code indicating the results of the request.

Learn more: HTTP Status Code Registry

Response Body

Related Links