Retrieve Info About a User

This page is no longer maintained (Mar 29, 2023). For the most current information, go to https://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

Path Parameters

Key

Description

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.

Request Body

None.

Response

Response Body

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

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

 

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.