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.

Postman Collections

Download a Postman Collection that provides all of the calls available for each of our OneLogin resources.

Try it out with a test account first: Start off with using a Postman Collection with a test OneLogin account and API key. Once you’ve familiarized yourself with the API’s behavior, switch over to using your production OneLogin account and API key.

Users

Download the Postman Collection for the Users API

To use this Postman Collection, you must define the following environment variables:

{{host}}

Start out with using this Postman Collection with a sandbox host.

Once you’ve familiarized yourself with the API’s behavior, move over to using it with a production account and set this value to http://api.onelogin.com.

{{api_key}}

Set this to the API key for your account.

{{password}}

Set this to x.

{{user_id}}

Set this to the user ID for which you want to make a request.

{{username}}

Set this to the username for which you want to make a request.

Roles

Download the Postman Collection for the Roles API

To use this Postman Collection, you must define the following environment variables:

{{host}}

Start out with using this Postman Collection with a sandbox host.

Once you’ve familiarized yourself with the API’s behavior, move over to using it with a production account and set this value to http://api.onelogin.com.

{{api_key}}

Set this to the API key for your account.

{{password}}

Set this to x.

{{role_id}}

Set this to the role ID for which you want to make a request.

SAML Assertion

Download the Postman Collection for the SAML Assertion API

To use this Postman Collection, you must define the following environment variables:

{{host}}

Start out with using this Postman Collection with a sandbox host.

Once you’ve familiarized yourself with the API’s behavior, move over to using it with a production account and set this value to http://api.onelogin.com.

{{api_key}}

API key assigned to the OneLogin account that contains the user and app for which you want to generate a SAML token.

{{username}}

Username of the OneLogin user accessing the app for which you want to generate a SAML token.

{{password}}

Password of the OneLogin user accessing the app for which you want to generate a SAML token. Required.

   

Delegated Auth

Download the Postman Collection for the Delegated Auth API

To use this Postman Collection, you must define the following environment variables:

{{host}}

Start out with using this Postman Collection with a sandbox host.

Once you’ve familiarized yourself with the API’s behavior, move over to using it with a production account and set this value to http://api.onelogin.com.

{{api_key}}

Set this to the API key for your account.

{{email}}

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

{{password}}

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

Invite Link

Download the Postman Collection for the Invite Link API

To use this Postman Collection, you must define the following environment variables:

{{host}}

Start out with using this Postman Collection with a sandbox host.

Once you’ve familiarized yourself with the API’s behavior, move over to using it with a production account and set this value to http://api.onelogin.com.

{{api_key}}

Set this to the API key for your account.

{{email}}

Set to the email address associated with the API key being used to make the call.

{{personal_email}}

To email the invite link to an address other than the email value, provide a personal_email value.


Events

Download the Postman Collection for the Events API

To use this Postman Collection, you must define the following environment variables:

{{host}}

Start out with using this Postman Collection with a sandbox host.

Once you’ve familiarized yourself with the API’s behavior, move over to using it with a production account and set this value to http://api.onelogin.com.

{{api_key}}

Set this to the API key for your account.

{{password}}

Set this to x.

{{event_id}}

Set this to the event ID for which you want to make a request.

Accounts

Download the Postman Collection for the Accounts API

To use this Postman Collection, you must define the following environment variables:

{{host}}

Start out with using this Postman Collection with a sandbox host.

Once you’ve familiarized yourself with the API’s behavior, move over to using it with a production account and set this value to http://api.onelogin.com.

{{api_key}}

Set this to the API key for your account.

{{password}}

Set this to x.

{{account_id}}

Set this to the account ID for which you want to make a request.

Groups

Download the Postman Collection for the Groups API

To use this Postman Collection, you must define the following environment variables:

{{host}}

Start out with using this Postman Collection with a sandbox host.

Once you’ve familiarized yourself with the API’s behavior, move over to using it with a production account and set this value to http://api.onelogin.com.

{{api_key}}

Set this to the API key for your account.

{{password}}

Set this to x.

{{group_id}}

Set this to the group ID for which you want to make a request.