Table of Contents
Get Started
- Quick Start
 - Structuring Resource Requests
 - Find Your Oracle Identity Cloud Service Tenant Name
 - Using the Postman Collection
 - Using cURL
 - 
                     
                     Managing Authorization
                        
                     
                     
                     
- Security Checklist
 - Scopes
 - Access Grant Types
 - Supported Tokens
 - Token Validation
 - 
                           
                           AppRole Permissions
                              
                           
                           
                           
- Application Administrator
 - Audit Administrator
 - Authenticated Client
 - Authenticator Client
 - Change Password
 - Cloud Gate
 - DB Admin
 - Forgot Password
 - Help Desk Administrator
 - Identity Domain Administrator
 - Kerberos
 - Me
 - MFA Client
 - Reset Password
 - Security Administrator
 - Self Registration
 - Signin
 - User Administrator
 - User Manager
 - Verify Email
 
 - AppRoles That Can Be Granted to Clients and Users
 
 - Deprecation Notices (Endpoints)
 - 
                     
                     Use Cases
                        
                     
                     
                     
- Adaptive Risk Analysis for Custom Client Applications
 - Creating an Enterprise Application with Authorization Policy
 - Importing and Exporting Users, Groups, and AppRoles
 - Managing Custom Claims
 - Managing the Refresh Token Expiration Value
 - 
                           
                           Managing User Schema Customizations
                              
                           
                           
                           
- Adding Custom User Schema Attributes Using PUT
 - Adding Custom User Schema Attributes Using PATCH
 - Validations Performed When Adding Attributes
 - Updating Custom User Schema Attributes Using PUT
 - Updating Custom User Schema Attributes Using PATCH
 - Validations Performed When Updating Attributes
 - Removing Custom User Schema Attributes Using PUT
 - Removing Custom User Schema Attributes Using PATCH
 - Validations Performed When Removing Attributes
 - Enabling the Import of Custom User Schema Attributes
 
 - Obtaining and Using an OAuth Token for Platform Services
 - Supporting Different URLs for Getting Refresh Token and Access Token
 - Triggering an Email Verification Flow if Email Address is Already Verified
 - Using Duo Security with Oracle Identity Cloud Service
 - Using OpenID Connect to Extend OAuth 2.0
 - Using Self Service to Enroll in MFA using the SMS Factor
 - 
                           
                           Using the Authenticate API to Develop a Custom
                              Sign-in Page
                           
                              
                           
                           
                           
- Authenticating with an External SAML Identity Provider
 - Authenticating with a Social Identity Provider
 - Authenticating with an External SAML Identity Provider and MFA
 - Creating a Session
 - Authenticating with User Name and Password
 - Authenticating User Name and Password with TOU Consent
 - Authenticating with User Name and Password and MFA and Return an OTP
 - Generating Access Token Using Authentication API
 - Authenticating with User Name and Password and MFA
 - Authenticating with User Name and Password and Enrolling in MFA
 - Authenticating User Name and Password and Enrolling in Account Recovery
 - Authenticating User Name and Password and Enrolling in Account Recovery and MFA
 
 - Using the Audit Event APIs
 - Using the onBehalfOf Allowed Operation
 - Using the On Demand MFA API to Develop Custom Sign-In Page
 - Working with Apps
 - Working with IDPs
 - Working with CORS
 - Working with Identity Providers
 - Working with OAuth 2 to Access the REST API
 
 - Authentication and On-Demand MFA API HTTP Status Codes
 - Authentication and On-Demand MFA API Error Codes
 
Tasks
- Adaptive Access
 - Apps
- Account Management Info
 - Account Object Class Templates
 - Account Object Classes
 - Account Owner Linker
 - Account Password Resetter
 - Account Status Changer
 - App Allowed Scopes Changer
 - App Config
 - App Entitlement Collection
 - App Kerberos Realm Updater
 - App Roles
 - App Status Changer
 - App Templates
 - App Upgrader
 - AppClient Secret Regenerator
 - Apps
 - Connector Bundles
 - Custom Connector Info
 - Grant Converter
 - Grant Evaluation Job Report
 - Grants
 - Idcs AppRole Grants
- Add a Grantee to an Oracle Identity Cloud Service AppRole
 - Get an Oracle Identity Cloud Service AppRole Grant
 - HTTP Options
 - Remove a Grantee from an Oracle Identity Cloud Service AppRole
 - Search Oracle Identity Cloud Service AppRole Grants
 - Search Oracle Identity Cloud Service AppRole Grants Using POST
 - Update an Oracle Identity Cloud Service AppRole Grant
 
 - Local Connector Bundles
 - Managed App Connection Tester
 - Managed App Operation Templates
 - Managed App Operations
 - Managed Object Class Templates
 - Managed Object Classes
 - Managed Object Sync Detailed Job Report
 - Managed Object Sync Job Report
 - Mapped Action Templates
 - Mapped Actions
 - Mapped Attribute Templates
 - Mapped Attributes
 - Pending Action
 - Pending Action Executor
 - Web Tier Policy JSON Validator
 
 - Audit
 - Authenticate
 - Bulk
 - Cloud Gate
- Cloud Gate Definition
 - Cloud Gate Mappings
 - Cloud Gate Servers
 - Cloud Gate Settings
 - Cloud Gate Upstream Server Groups
- Create a Cloud Gate upstream server group
 - Delete a Cloud Gate upstream server group
 - Get a Cloud Gate upstream server group
 - HTTP Options
 - Replace a Cloud Gate upstream server group
 - Search Cloud Gate upstream server group
 - Search Cloud Gate upstream server group Using POST
 - Update a Cloud Gate upstream server group
 
 - Cloud Gate Upstream Servers
 
 - Common
- Allowed Values
 - Branding Settings
 - Custom Allowed Values
 - Custom Claims
 - Exportable Resource Types
 - Feature
 - Feature Info
 - Latest Binary File Information Based On Version
 - Resource Type Schema Attributes
 - Resource Types
 - Schemas
 - Service Provider Configurations
 - Settings
 - Tags
 - Tenant Feature State
 - User Attributes Settings
 
 - Discovery
 - IDBridge
 - Identity
- Account Recovery Settings
 - Api Keys
 - Applicable Password Policy Retriever
 - Asserter
 - Auth Tokens
 - Customer Secret Keys
 - DBGroups
 - Diagnostic Records
 - DynamicResourceGroup
 - Groups
- Create a Group
 - Delete a Group
 - Get a Group - The Group search and get operations on users/members will throw an exception if it has more than 10K members, to avoid the exception use the pagination filter to get or search group members
 - HTTP Options
 - Replace a Group
 - Search Groups Using POST
 - Search Groups.The Group search and get operations on users/members will throw an exception if it has more than 10K members, to avoid the exception use the pagination filter to get or search group members
 - Update a Group
 
 - Identity Config
 - Identity Settings
 - Kerberos Realm Users
 - My Api Keys
 - My Auth Tokens
 - My Customer Secret Keys
 - My OAuth2 Client Credentials
 - My Smtp Credentials
 - My User DB Credentials
 - MySupportAccount
 - OAuth2 Client Credentials
 - Password Authenticator
 - Password Policies
 - Resource Exporter
 - Resource Importer
 - Security Question Settings
 - Security Questions
 - Self Registration Profiles
 - Smtp Credentials
 - SupportAccount
 - User Activation Initiator
 - User Apps Enabled For Authentication
 - User Apps Enabled For Delegated Authentication
 - User Attributes Validator
 - User Capabilities Changer
 - User DB Credentials
 - User DB login status update
 - User Locked State Changer
 - User Name Generator
 - User Password Changer
 - User Password Generator
 - User Password Resetter
 - User Password Validator
 - User Status Changer
 - User Token Validator
 - User Tokens
 - Users
 
 - Jobs
 - Multi-Factor Authentication (MFA)
 - My Access
 - Notification
 - OAuth Runtime
 - OAuth2
 - On-Demand MFA
- Factor Enrollment
- Change Default MFA Factor or Un-Enroll in MFA
 - Complete Factor Enrollment or Resend OTP or Update Security Questions
 - Delete an Enrolled MFA Factor
 - Get Enrolled MFA Factors Using a Filter
 - Get Enrolled MFA Factors Using the User GUID
 - Get Factor Enrollment Status
 - HTTP Options
 - Initiate MFA Factor Enrollment With Verification or MFA Factor Enrollment Without Verification
 
 - Factor Verification
 
 - Factor Enrollment
 - Policy
 - RADIUS Proxy
 - Replication
 - Reports
- AppRole Membership Import Detailed Job Reports
 - AppRole Membership Import Summary Job Reports
 - Bulk User Password Reset Job Reports
 - Columns
 - Grant Import Detailed Job Reports
 - Grant Import Summary Job Reports
 - Group Import Detailed Job Reports
 - Group Import Summary Job Reports
 - IdcsReports
 - Metered Event
 - Report Templates
 - Reports
 - User Import Job Reports
 
 - SAML
 - Secure Form Fill (SFF)
 - Security
 - Self-Service
- Me
 - Me Activator
 - Me Email Verified
 - Me Email Verifier
 - Me Password Changer
 - Me Password Must Changer
 - Me Password Recovery Factor Validator
 - Me Password Recovery Option Retriever
 - Me Password Reset Requestor
 - Me Password Resetter
 - Me Remove Pending Verification Email Data
 - Me Security Question Answer Validator
 - Me Security Questions Retriever
 - My Accesses
 - My App Favorite Setter
 - My Apps
 - My Authentication Factor Enroller
 - My Authentication Factor Initiator
 - My Authentication Factor Validator
 - My Authentication Factors Remover
 - My Bypass Codes
 - My Devices
 - My Social Accounts
 - My Trusted User Agents
 
 - Single Sign-On (SSO)
 - Social
 - Storage
 - Terms Of Use