Qodex.ai

IDCS APIs

Number of APIs: 299

This code contains a collection of sample REST API requests that can be used with clients such as Qodex to make test calls to Oracle Identity Cloud Service.

This application is provided “AS IS” with no express or implied warranty for accuracy or accessibility. The sample code is intended for study purposes, doesn't represent the recommended approach, and isn't intended to be used in development or production environments.

The Using the Oracle Identity Cloud Service REST APIs with Qodex tutorial is available to use with this REST API collection.

Requirements

  • Register and activate a client application in Oracle Identity Cloud Service with the following characteristics, and then copy the application client id and client secret:
  • Application Type: Trusted
  • Name: REST Test
  • Description: This client is used to test REST API calls
  • Authorization: Select Configure this application as client now
  • Allowed Grant Types: Select Client Credentials

- Grant the client access to Oracle Identity Cloud Service Admin APIs: Select this check box, and then in the box that appears, select Identity Domain Administrator

Set Up

  1. Click the Environment drop-down list in the upper-right corner, and then select IDCS APIs
  2. Click Environment quick look (eye icon), and then select Edit.
  3. Update the environment variables, and then click Save:
  • HOST: The Oracle Identity Cloud Service UI address, for example: https://example.identity.oracle.com
  • CLIENT_ID and CLIENT_SECRET: The client id and client secret that you obtained from your Oracle Identity Cloud Service application
  • USER_LOGIN and USER_PW: The user login and password

  1. Bulk-Import & Export Groups - Schedule a job - import bulk groups - generic POST {{HOST}}/job/v1/JobSchedules

  2. Audit Events-Search for Notification Events - Search all events for email notification delivery successes GET {{HOST}}/admin/v1/AuditEvents?filter=eventId eq "notification.delivery.success" and notificationDeliveryChannel eq "EMAIL"&sortedBy=timestamp&sortOrder=descending

  3. MFA-Security Questions-Create - Create a security question POST {{HOST}}/admin/v1/SecurityQuestions

  4. Policy-Network Perimeter - Get a Network Perimeter GET {{HOST}}/admin/v1/NetworkPerimeters/{id}

  5. MFA-Self Service-Enrolling in MFA Using the Security Questions Factor - Get the Security Questions Settings GET {{HOST}}/admin/v1/SecurityQuestionSettings/SecurityQuestionSettings

  6. Audit Events-Search for User Events-Failure Events - Search all events for user login failures GET {{HOST}}/admin/v1/AuditEvents?filter=eventId eq "sso.authentication.failure"

  7. MFA-Self Service-Bypass Codes Self Service - Delete a Bypass Code DELETE {{HOST}}/admin/v1/MyBypassCodes/{{BypassCodeId}}

  8. Users-Membership - Search all users who are members of a specific group GET {{HOST}}/admin/v1/Users?filter=groups.value eq "{{groupid}}"

  9. MFA-Security Questions-Search - Search for a specific security question (return question text) - System Generated ID GET {{HOST}}/admin/v1/SecurityQuestions/92bab3dd8d454fadb132b5513b22d6de?attributes=questionText

  10. SAML-Service Provider-Create - Create a service provider POST {{HOST}}/admin/v1/ServiceProviders