Skip to main content
OneLogin
  • BLOG
  • DOCS
  • API REFERENCE
  • SUPPORT
Free Trial (opens in new tab)
Free Trial (opens in new tab)

▶ Getting Started

  • Developer Overview
  • Authorizing Resource API Calls
  • Working with API Credentials
  • Using Query Parameters
  • Postman Collections
  • Client SDKs

▶ OAuth 2.0 Tokens

  • POST Generate Tokens
  • Refresh Tokens
  • Refresh Token
  • POST Revoke Token
  • GET Get Rate Limit

▶ Users

  • User Resource
  • POST Create User
  • GET List Users
  • GET Get User
  • GET Get User Apps
  • PUT Update User
  • DELETE Delete User
  • POST Unlock User
  • POST Bulk Logout Users
  • POST Create Custom Attribute
  • GET List Custom Attributes
  • GET Get Custom Attribute
  • PUT Update Custom Attribute
  • DELETE Delete Custom Attribute
  • GET Get User Privileges
  • GET Get User Delegated Privileges

▶ User Mappings

  • Overview
  • POST Create Mapping
  • POST Dry Run Mapping
  • GET List Mappings
  • GET Get Mapping
  • PUT Update Mapping
  • DELETE Delete Mapping
  • GET List Conditions
  • GET List Condition Operators
  • GET List Condition Values
  • GET List Actions
  • GET List Action Values
  • PUT Bulk Sort

▶ User Self Registration

  • POST Create Profile
  • GET List All Profiles
  • GET Get Specific Profile
  • PUT Update Profile
  • DELETE Delete Profile
  • POST Add Field to Profile
  • DELETE Remove Field from Profile

▶ Apps

  • Overview
  • App Resource
  • POST Create an App
  • GET List Apps
  • GET Get an App
  • PUT Update an App
  • DELETE Delete an App Parameter
  • DELETE Delete an App
  • GET List App Users

▶ App Rules

  • Overview
  • POST Create Rule
  • GET List Rules
  • GET Get Rule
  • PUT Update Rule
  • DELETE Delete Rule
  • GET List Conditions
  • GET List Condition Operators
  • GET List Condition Values
  • GET List Actions
  • GET List Action Values
  • PUT Bulk Sort

▶ Roles

  • POST Create Roles
  • GET List Roles
  • GET Get Role
  • PUT Update Role
  • DELETE Delete Role
  • GET Get Role Apps
  • PUT Set Role Apps
  • POST Add Role Users
  • GET Get Role Users
  • DELETE Remove Role Users
  • POST Add Role Admins
  • GET Get Role Admins
  • DELETE Remove Role Admins

▶ Groups

  • Group Resource
  • POST Create Group
  • GET List Groups
  • GET Get Group
  • PUT Update Group
  • DELETE Delete Group

▶ Security Policies

  • Policy Resource
  • POST Create Security Policy
  • GET Get Security Policies
  • GET Get Security Policy by ID
  • PUT Update Security Policy
  • PUT Set Security Policy as Default
  • DELETE Delete Security Policy

▶ Connectors

  • GET List Connectors

▶ Branding

  • Overview
  • Base64 Image Converter
  • POST Create Account Brand
  • GET List Account Brands
  • GET Get Account Brand
  • GET Get Apps Associated with Account Brand
  • PUT Update Account Brand
  • DELETE Delete Account Brand
  • GET Get Email Settings
  • PUT Update Email Settings Config
  • DELETE Reset Email Settings Config
  • POST Create Message Template
  • GET List Message Templates
  • GET Get Message Template
  • GET Get Message Template by Type
  • GET Get Message Template by Type & Locale
  • GET Get Master Message Template by Type
  • GET Get Master Message Template by Type & Locale
  • PUT Update Message Template
  • PUT Update Message Template by Type & Locale
  • DELETE Delete Message Template
  • GET List Languages
  • POST Lookup Custom Message
  • POST List Custom Messages
  • PUT Update Custom Message
  • DELETE Delete Custom Message

▶ Multi-Factor Authentication

  • Upgrade V1 to V2
  • Overview
  • POST Enroll a Factor
  • POST Activate a Factor
  • POST Verify a Factor SMS, Email, Authenticator
  • POST Generate MFA Token
  • GET List Authentication Factors
  • GET Get Available Factors
  • GET Verify Enrollment Voice & Protect
  • GET Get Enrolled Factors
  • GET Verify a Factor Protect & Voice
  • PUT Verify Enrollment SMS, Email, Protect, Authenticator
  • PUT Verify a Factor SMS, Email, Authenticator
  • DELETE Remove a Factor

▶ OATH Tokens

  • The OATH Token Resource
  • POST Import OATH Tokens
  • GET List OATH Tokens
  • GET Get OATH Token
  • DELETE Delete OATH Token

▶ SAML Assertions

  • POST Generate SAML Assertion
  • POST Verify Factor

▶ Smart MFA

  • Overview
  • POST Step 1 - Validate a User
  • POST Step 2 - Verify MFA Token

▶ Smart Hooks

  • Overview
  • POST Create a Hook
  • GET List Hooks
  • GET Get a Hook
  • GET Get Hook Logs
  • PUT Update a Hook
  • DELETE Delete a Hook
  • POST Create Environment Variable
  • GET List Environment Variables
  • GET Get Environment Variable
  • PUT Update Environment Variable
  • DELETE Delete Environment Variable

▶ API Authorization

  • Overview
  • API Authorization Resource
  • POST Create Authorization Server
  • GET List Authorization Servers
  • GET Get Authorization Server
  • PUT Update Authorization Server
  • DELETE Delete Authorization Server
  • POST Add an Access Token Claim
  • GET List Access Token Claims
  • PUT Update an Access Token Claim
  • DELETE Delete an Access Token Claim
  • POST Add a Scope
  • GET List Scopes
  • PUT Update a Scope
  • DELETE Delete a Scope
  • POST Add Client App
  • GET Get Client Apps
  • PUT Update a Client App
  • DELETE Remove a Client App

▶ Reports

  • POST Run Report
  • POST Run Report in Background
  • GET List Reports

▶ Vigilance

  • Overview
  • POST Track an Event
  • POST Get a Risk Score
  • POST Create a Rule
  • GET List Rules
  • GET Get a Rule
  • PUT Update a Rule
  • DELETE Delete a Rule
  • GET Get Score Insights

Events (V1)

Login Page (V1)

Privileges (V1)

Invite Links (V1)

Embed Apps (V1)

Samples (V1)

Contact Us

Bug report icon

Found a Bug?

Submit a support ticket.

Ideas icon

Have an Idea?

Share it in our Ideas Portal.

Community

Connect on GitHub or Twitter.

Documentation

Browse our API docs and guides.

OneLogin
 
  • TERMS
  • ///
  • PRIVACY
  • ///
  • SECURITY (opens in new tab)
  • ///
  • COMPANY (opens in new tab)
  • ///
  • CAREERS (opens in new tab)
  • ///
  • SAMLTOOL.COM (opens in new tab)
© 2015 - 2026 OneLogin, Inc. All Rights Reserved