APIs

APIs - Overview

This is the REST API documentation for Asgardeo.

APIs in Asgardeo

Asgardeo exposes a set of APIs, which allows you to manage various organization settings and application settings programmatically using the APIs. This is an alternative to using the Asgardeo Console.

Some of these APIs are used for management purposes and they have special authentication requirements. The management APIs in Asgardeo are as follows:

• Application management API
• OAuth 2 DCR API
• Identity provider management API
• Email templates API
• User management API (SCIM2)
  • me endpoint
  • users endpoint
  • group endpoint
  • bulk endpoint
  • resource type endpoint
  • service provider config endpoint
• Identity governance API
• User session management API
• User session extension API
• Self-service APIs
  • TOTP API
  • Backup codes API
  • Password recovery API
  • Export user information API
• Export admin information API
• Consent management API
• Event configuration management API
• Validation API
• Idle account identification API
• Password expiring users identification API
• Organization APIs

Authentication

You need an access token to invoke APIs in Asgardeo. If you are an administrator or developer who has access to the Asgardeo Console, you can generate the required access tokens.

The process of obtaining access tokens is different for management APIs and other APIs of Asgardeo.

Learn how to:

• get access tokens for management APIs.
• get access tokens for other APIs.
• get access tokens for organization APIs.