Retrieve info about a user

GET /users/{email}


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


  • Environment (Org) admin permissions


 GET https://{controlplane_path}/api/1/rest/public/users/{email}

Path Parameters

Key Description
controlplane_path Required. The path to the SnapLogic control plane.


For other control planes, substitute the subdomain name for elastic. For example:
email Required. The email address of the user.

Query Parameters


Request Header

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

Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json

Request Body



Note: The results include only the user information that you have permissions to view.

Response Body

  "last_name": "...",
  "first_name": "...",
  "password_last_updated": "...",
  "password_expired": true,
  "allow_password_login": true,
  "organizations": [
      "id": "...",
      "name": "..."
      "administrator": true,
  "basic_access": "...",
  "ui_access": true,
  "user_locked_out": true,
  "service_account": true,
  "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
organizations array An array of objects containing information about the Environments/Orgs that the user belongs to. Each object contains name and id of the Environment/Org and a Boolean (administrator) that indicates whether the user is assigned the administrator role in the Environment/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.
email string The user's email address.