See api-docs Menu

v1-v3 APIs have been deprecated

Don't worry, these APIs are deprecated, but they won't be shut off until 2017, at the earliest. Questions? Contact devsupport@onelogin.com.

All new development with APIs should use the newest version of our API: /1. API /1 is based on RESTful principles, is secured by OAuth 2.0, and provides JSON messages, search, pagination, sorting, and filtering.

Delegate App User Authentication to OneLogin

Delegates your app’s user authentication to OneLogin. For example, you can take the username and password supplied to your app, pass it to OneLogin along with your API key, and have OneLogin authenticate the user.

Resource URL

https://api.onelogin.com/api/v1/delegated_auth

Parameters

email

required

string

Provide the email of the app user that you want to authenticate in OneLogin.

password

required

string

Provide the password of the app user that you want to authenticate in OneLogin.

Sample Response

Here are a few different errors that will return a 200 OK status code:
--------------------------------------------------------

<response>
  <authenticated>true</authenticated>
  <firstname>Genoveva</firstname>
  <lastname>Hasegawa</lastname>
  <message>Success</message>
</response>

--------------------------------------------------------

<response>
  <authenticated>false</authenticated>
  <message>Invalid password</message>
</response>

--------------------------------------------------------

<response>
  <authenticated>false</authenticated>
  <message>Account not found</message>
</response>

--------------------------------------------------------

<response>
  <authenticated>false</authenticated>
  <message>User not found</message>
</response>

Response Elements

authenticated

Valid values are:

  • true: User has been authenticated.
  • false: User could not be authenticated.

firstname

If the user has been successfully authenticated in OneLogin, displays the first name of the user in OneLogin.

lastname

If the user has been successfully authenticated in OneLogin, displays the last name of the user in OneLogin.

message

Describes the result of the request. For example:

  • Success
  • Invalid password
  • Account not found

Sample cURL Request

Be sure to replace placeholder values surrounded by { } with actual values.

curl -X GET https://api.onelogin.com/api/v1/delegated_auth?api_key={api_key}&email={email} \
&password={password}

Postman Collection

Be sure to set Postman-specific environment variables indicated by {{ }}.

Download for the Delegated Auth API