Versions Compared

Old Version 5

changes.mady.by.user Eleanor Tesoro

Saved on

compared with

New Version 6

changes.mady.by.user Eleanor Tesoro

Saved on

Key

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

GET /users/{email}

Overview

This API retrieves the user record associated with the specified email address.

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
GET http://{pod_path}/api/1/rest/public/users/{email}

Path Parameters

Key

Description

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

email

Required. The email address associated with the user record.

Query Parameters

None.

Request Header

Specify Basic Auth for authorization.

Paste code macro
themeAscetic
Authorization: Basic {your_encoded_security_credentials}

Request Body

None.

Response

Response Header

Key

Description

X-SL-StatusCode

Status code indicating the results of the request.

Learn more: HTTP Status Code Registry

Response Body

Paste code macro
themeAscetic
{
    "last_name": "...",
    "first_name": "...",
    "password_last_updated": "...",
    "password_expired": ...,
    "allow_password_login": ...,
    "organizations": [
      {
        "administrator": ...,
        "id": "...",
        "name": "..."
      },
      ...
    ],
    "basic_access": "...",
    "ui_access": ...,
    "user_locked_out": ...,
    "service_account": ...,
    "email": "..."
}

Key

Type

Description

last_name

string

The last name of the user.

first_name

string

The first name of the user.

password_last_updated

string

When the user's password was last updated. Format: UTC

password_expired

Boolean

If true, the user's password is expired.

allow_password_login

Boolean

If true, ???

organizations

array of objects

The list of Orgs that the user belongs to. Each object contains name and id of the Org and a Boolean (administrator) that indicates whether the user is assigned the administrator role in the Org.

basic_access

string

??? Format: UTC

ui_access

Boolean

If true, the user can use the SnapLogic UI. ???

user_locked_out

Boolean

If true, the user is denied access to the Snaplex. ???

service_account

Boolean

If true, ???.

email

string

The user's email address.

Related Links