1. Home >
2. API >
3. 1 >
4. Get Started >
5. Developer Overview

Developer Overview

Welcome to the OneLogin API.

This API is based on RESTful principles, is secured by OAuth 2.0, and provides JSON messages, search, pagination, sorting, and filtering.

API Domain

The OneLogin API uses your subdomain as the API Domain. This is the same address you would use to login to OneLogin.

    <subdomain>.onelogin.com
  

Versioning

The version number for the api is indicated in the url. Versioning starts at 1 and increases as we make major changes to any of the APIs or their payloads. It is recommended to always use the latest version.

For example, Get Users API is currently on version 1 `GET /api/1/users` where as Get Apps API is on version 2 `GET /api/2/apps`.

Job System Delays

Most API calls are handled by the job system immediately. However, in some circumstances, it may take up to 5 minutes for a queued API job to be handled by the job system.

API Endpoints

Apps App Resource List Apps Get App Create App Update App Delete Parameter Delete App Connectors List Connectors Users User Resource Get Users Get User by ID Get Apps for a User Get Roles Assigned to a User Get Custom Attribute Fields Create User Delegate Authentication Update User Assign Roles to a User Remove Roles for a User Set Password Using Cleartext Set Password Using SHA-256 Set Custom Attribute Values for a User Set User State Log User Out Lock User Account Delete User Events Event Resource and Types Get Events Get Event Types Get Event by ID

OAuth 2.0 Tokens Generate Tokens Refresh Tokens Revoke Tokens Get Rate Limit Multi-Factor Authentication Overview Get Available Factors Enroll a Factor Get Enrolled Factors Activate a Factor Verify a Factor Generate MFA Token Custom Login Pages Log in User via API Create Session Login Token Verify Factor Session Via API Token SAML Assertions Generate SAML Assertion Verify Factor Roles Get Roles Get Role by ID Groups Get Groups Get Group by ID Invites Generate Invite Link Send Invite Link Embed Apps Embed Apps