# OneLogin — HRIS API: overview

> Canonical URL: https://developers.apideck.com/apis/hris/onelogin/overview


- Status: beta
- Authentication: oauth2

- **important to know:** OneLogin ties API credentials to the user who created them. If that user is later deleted, the credentials fail with HTTP 500 and the consumer must create a new pair and reconnect, so have them create the pair from a long-lived admin account.
- **partnership required:** false
- **responsibility matrix:**   - **area:** Enable the OneLogin Connector
  - **customer:** ✓ Via Apideck Dashboard
  - **consumer:** ✓
  - **area:** Create the API Credentials in OneLogin
  - **area:** Supply the Client ID, Secret & Subdomain in Vault
  - **consumer:** ✓
  - **area:** Store & Encrypt Credentials
  - **apideck:** ✓
  - **apideck:** ✓
  - **area:** Obtain & Renew Access Tokens
  - **apideck:** ✓ Maintains connector
  - **customer:** ✓ Builds the requests
  - **area:** Build via the Unified API
  - **customer:** ✓ Via Apideck Dashboard
  - **apideck:** ✓ Logs & alerts
  - **area:** Monitor Connections
- **authentication note:** Client credentials grant, using a client ID and secret.
- **partnership note:** Nothing has to be registered with OneLogin to use this connector.
- **sandbox note:** Start a OneLogin free trial to get a test account, then create API credentials in it the same way as in production.
- **consumer access level:** A OneLogin account owner or administrator, since only those roles can create API credentials.
- **external guides:**   - **title:** OneLogin API documentation
  - **url:** https://developers.onelogin.com/api-docs
  - **source:** OneLogin
  - **source:** OneLogin
  - **title:** Working with API credentials
  - **url:** https://developers.onelogin.com/api-docs/2/getting-started/working-with-api-credentials
- **difficulty reason:** API Credentials - Each Consumer Creates a Client ID and Secret in OneLogin
- **apideck credentials note:** Each consumer creates their own OneLogin API credentials.
- **sandbox available:** true
- **beta:** true
- **difficulty:** moderate
- **environment notes:**   - **environment:** Test and production
  - **description:** A OneLogin trial is a separate account with its own subdomain and credential pair, so a production connection needs a pair created in the production account. A production connection acts on live user and directory data.
- **apideck credentials available:** false
- **account type required:** Any OneLogin account where the consumer can open Developers > API Credentials.

## Supported resources

- **status:** live
- **downstream id:** users
- **custom field support:** true
- **downstream name:** Users
- **id:** employees
- **name:** Employees

An omitted operation list does not establish operation support. Verify the selected operation in the coverage matrix.

[API reference](https://developers.apideck.com/apis/hris/reference.md) · [Coverage matrix](https://developers.apideck.com/apis/hris/coverage)