Oracle Cloud Infrastructure Documentation

Getting Started with the Identity Domains REST API

The identity domains REST API securely manage resources, including identities and configuration data. Support for OpenID Connect allows integration with compliant applications and identity domains. The OAuth2 service provides an API infrastructure for authorization that supports a range of token grant types that enable you to securely connect clients to services.

The identity domains REST API supports SCIM 2.0 compliant endpoints with standard SCIM 2.0 core schemas and Oracle schema extensions to:

  • Manage users, groups, and apps.

  • Perform identity functions, including password generation and reset.

  • Perform administrative tasks including bulk operations and job scheduling.

  • Configure settings for an identity domain including multifactor authentication, branding, and notification templates.

This guide contains the following sections:

  • Endpoints Deprecation Notices: Learn about endpoints deprecation notices for identity domains.
  • Quick Start: Quickly get started with the identity domains REST API by completing prerequisites, installing curl, and setting up authorization to manage your identity domain resources such as users, groups, and applications.
  • API Rate Limits: Understand the rate limiting for APIs for different identity domain types.
  • Structuring Resource Requests: Learn the guidelines for building send requests in an identity domain.
  • Using cURL: Learn how to use cURL to access the REST APIs.
  • Managing Authorization Using the API: Learn how to use an OAuth client to access identity domains REST API. The identity domains REST API isn't accessible using only an identity domain username and password. To access the identity domains REST API, you need an OAuth2 access token or an API key to use for authorization.
  • API Use Cases: Step through typical use cases using the identity domain REST APIs.

The following resources aren't in this guide but are also available to you.

When using the identity domains user interface:

When using the API or CLI:

  • To manage identity domains (for example, creating or deleting a domain), see IAM API.
  • To manage resources within an identity domain, for example, users, dynamic resource groups, groups, and identity providers, see Identity Domains CLI.