Home >
API >
v1-v3 >
Delegated Auth >
Delegate App User Authentication to OneLogin

v1-v3 APIs have been deprecated.

Although these APIs are not shut off yet, all new development with APIs should use the newest version of our API if available, and the version /1 in all other cases. These later versions are based on RESTful principles, secured by OAuth 2.0, and provide 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

200 OK

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

Clicking Run in Postman button navigates to the page where you can fork the collection to your workspace. Forking the collection into your workspace will enable you to contribute to the source collection using pull requests. You can also view the collection in a public workspace if you like and even import a copy of the collection using the links present on the screen.

Have a Question?

Found a problem or a bug? Submit a support ticket.

Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.

Have a product idea or request? Share it with us in our Ideas Portal.