Versions Compared

Old Version 4

changes.mady.by.user Eleanor Tesoro

Saved on

compared with

New Version Current

changes.mady.by.user Subhajit Sengupta

Saved on

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/get-users-email.html.

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

GET /users/{email}

Overview

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

Prerequisites

You need:

  • Org Admin permissions.

Request

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}

...

Request

...

themeAscetic

...

GET https://{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

...

for authorization and application/json for content type.

...

appsplus-panel-macro-confluence-macro

...

themeAscetic
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

None.

Response

Response

...

Key

...

Description

...

X-SL-StatusCode

...

Status code indicating the results of the request.

Learn more: HTTP Status Code Registry

...

Body

...

Code Block

...

...

language

...

json
{

...

...

"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": ...,
  "

...

failed_

...

logins": ...,
  "failed_logins": ...,
  "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

...

changed. Format: UTC

password_expired

Boolean

If true, the user's password is expired.

allow_password_login

Boolean

...

If true, ???

...

organizations

organizations

array

An array of objects

...

containing information about the 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

...

failed_logins

integer

The number of login attempts that failed.

failed_logins

integer

The number of login attempts that failed.

email

string

The user's email address.

...