All REST Endpoints
Adaptive Access/Adaptive Access Settings
Use this endpoint to manage tenant-specific adaptive access settings. This REST API is SCIM compliant.
There is a single pre-seeded instance of AdaptiveAccessSettings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
Added In Release: 18.1.6
There is a single pre-seeded instance of AdaptiveAccessSettings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
Added In Release: 18.1.6
- Get Adaptive Access Settings
- Method: getPath:
/admin/v1/AdaptiveAccessSettings/{id}
- HTTP Options
- Method:Path:
/admin/v1/AdaptiveAccessSettings
- Replace Adaptive Access Settings
- Method: putPath:
/admin/v1/AdaptiveAccessSettings/{id}
- Search Adaptive Access Settings
- Method: getPath:
/admin/v1/AdaptiveAccessSettings
- Search Adaptive Access Settings Using POST
- Method: postPath:
/admin/v1/AdaptiveAccessSettings/.search
- Update Adaptive Access Settings
- Method: patchPath:
/admin/v1/AdaptiveAccessSettings/{id}
Adaptive Access/Risk Provider Profile
Use this endpoint to manage risk provider configurations for Oracle Identity Cloud Service. The risk provider configuration manages all of the fields that are required to connect with the provider and other relevant configurations. This REST API is SCIM compliant.
Added In Release: 18.1.6
Added In Release: 18.1.6
- Create a Risk Provider Profile
- Method: postPath:
/admin/v1/RiskProviderProfiles
- Delete a Risk Provider Profile
- Method: deletePath:
/admin/v1/RiskProviderProfiles/{id}
- Get a Risk Provider Profile
- Method: getPath:
/admin/v1/RiskProviderProfiles/{id}
- HTTP Options
- Method:Path:
/admin/v1/RiskProviderProfiles
- Replace a Risk Provider Profile
- Method: putPath:
/admin/v1/RiskProviderProfiles/{id}
- Search Risk Provider Profiles
- Method: getPath:
/admin/v1/RiskProviderProfiles
- Update a Risk Provider Profile
- Method: patchPath:
/admin/v1/RiskProviderProfiles/{id}
Adaptive Access/Risk Provider Profile Validation
Use this endpoint to validate a risk provider profile. This REST API is SCIM compliant.
Added In Release: 18.1.6
Added In Release: 18.1.6
- HTTP Options
- Method:Path:
/admin/v1/RiskProviderProfileValidation
- Validate a Risk Provider Profile
- Method: postPath:
/admin/v1/RiskProviderProfileValidation
Adaptive Access/Threats
Use this endpoint to manage adaptive access threats and violations. This REST API is SCIM compliant.
Added In Release: 18.1.6
Added In Release: 18.1.6
- Get an Existing Threat or Violation
- Method: getPath:
/admin/v1/Threats/{id}
- HTTP Options
- Method:Path:
/admin/v1/Threats
- Replace a Threat or Violation
- Method: putPath:
/admin/v1/Threats/{id}
- Search Threats or Violations
- Method: getPath:
/admin/v1/Threats
- Update a Threat or Violation
- Method: patchPath:
/admin/v1/Threats/{id}
Adaptive Access/User Devices
Use this endpoint to manage user devices for each tenant. This REST API is SCIM compliant.
Added In Release: 18.1.6
Added In Release: 18.1.6
- Get a User Device
- Method: getPath:
/admin/v1/UserDevices/{id}
- HTTP Options
- Method:Path:
/admin/v1/UserDevices
- Search User Devices
- Method: getPath:
/admin/v1/UserDevices
Apps/Account Management Info
Use this internal endpoint to manage information for an account that is granted to a user. The AccountMgmtInfo endpoint keeps track of various pieces of information such as the owner of the account, the application in which the account is granted, when the account was last accessed, whether the account is a favorite of the user and other attributes such as when and by whom the account was granted or modified. AccountMgmtInfo is the base entity on top of which /MyApps and /UserApps endpoints have been implemented to retrieve Apps granted to a user using various search criteria.
Added In Release: 17.3.6
Added In Release: 17.3.6
- Get Account Mgmt Info
- Method: getPath:
/admin/v1/AccountMgmtInfos/{id}
- HTTP Options
- Method:Path:
/admin/v1/AccountMgmtInfos
- Search Account Mgmt Info
- Method: getPath:
/admin/v1/AccountMgmtInfos
- Search Account Mgmt Info Using POST
- Method: postPath:
/admin/v1/AccountMgmtInfos/.search
Apps/Account Object Class Templates
Use this endpoint to manage account object-class template configurations for a connected managed app. This REST API is SCIM compliant.
- Create an Account ObjectClass Template
- Method: postPath:
/admin/v1/AccountObjectClassTemplates
- Delete an Account ObjectClass Template
- Method: deletePath:
/admin/v1/AccountObjectClassTemplates/{id}
- Get an Account ObjectClass Template
- Method: getPath:
/admin/v1/AccountObjectClassTemplates/{id}
- HTTP Options
- Method:Path:
/admin/v1/AccountObjectClassTemplates
- Replace an Account ObjectClass Template
- Method: putPath:
/admin/v1/AccountObjectClassTemplates/{id}
- Search Account ObjectClass Templates
- Method: getPath:
/admin/v1/AccountObjectClassTemplates
- Search Account ObjectClass Templates Using POST
- Method: postPath:
/admin/v1/AccountObjectClassTemplates/.search
- Update an Account ObjectClass Template
- Method: patchPath:
/admin/v1/AccountObjectClassTemplates/{id}
Apps/Account Object Classes
Use this endpoint to manage account object-class configurations for a connected managed app. This REST API is SCIM compliant.
- Get an Account ObjectClass
- Method: getPath:
/admin/v1/AccountObjectClasses/{id}
- HTTP Options
- Method:Path:
/admin/v1/AccountObjectClasses
- Replace an Account ObjectClass
- Method: putPath:
/admin/v1/AccountObjectClasses/{id}
- Search Account ObjectClasses
- Method: getPath:
/admin/v1/AccountObjectClasses
- Search Account ObjectClasses Using POST
- Method: postPath:
/admin/v1/AccountObjectClasses/.search
- Update an Account ObjectClass
- Method: patchPath:
/admin/v1/AccountObjectClasses/{id}
Apps/Account Owner Linker
Use this endpoint to manually link an account to its owner. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/AccountOwnerLinker
- Manually Link an Owner to an Account
- Method: putPath:
/admin/v1/AccountOwnerLinker/{id}
Apps/Account Password Resetter
Use this endpoint to reset the password of an Identity Connector Framework-based managed app account. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/AccountPasswordResetter
- Reset Account Password
- Method: putPath:
/admin/v1/AccountPasswordResetter/{id}
Apps/Account Status Changer
Activate or deactivate an account by setting its active attribute to true or false. This REST API is SCIM compliant.
- Activate/Deactivate an Account
- Method: putPath:
/admin/v1/AccountStatusChanger/{id}
- HTTP Options
- Method:Path:
/admin/v1/AccountStatusChanger
Apps/App Allowed Scopes Changer
This endpoint is a specially authorized convenience endpoint that allows an administrator to add or delete allowed scopes to an OAuth Client, specified by an ID that is provided in the payload.
Deprecated Since Release: 17.4.2
Deprecated Since Release: 17.4.2
- Add/Remove Allowed Scopes to OAuth Client App
- Method: postPath:
/admin/v1/AppAllowedScopesChanger
- HTTP Options
- Method:Path:
/admin/v1/AppAllowedScopesChanger
Apps/App Config
Use this endpoint to obtain a list of attributes for providing the attributes that various actors can update in an OPC App. This endpoint is a singleton resource in the "global schema".
Added In Release: 18.2.6
Added In Release: 18.2.6
- Get an App Config
- Method: getPath:
/admin/v1/AppConfig/{id}
- HTTP Options
- Method:Path:
/admin/v1/AppConfig
- Replace an App Config
- Method: putPath:
/admin/v1/AppConfig/{id}
- Search App Configs Using POST
- Method: postPath:
/admin/v1/AppConfig/.search
- Search for App Configs
- Method: getPath:
/admin/v1/AppConfig
- Update an App Config
- Method: patchPath:
/admin/v1/AppConfig/{id}
Apps/App Entitlement Collection
Use this endpoint to manage collections of entitlements from Apps. An administrator can grant an AppEntitlementCollection as a single gesture that causes the grantee to receive every entitlement in that collection. This REST API is SCIM-compliant.
Added In Release: 18.2.4
Added In Release: 18.2.4
- Create an App Entitlement Collection
- Method: postPath:
/admin/v1/AppEntitlementCollections
- Get an App Entitlement Collection
- Method: getPath:
/admin/v1/AppEntitlementCollections/{id}
- HTTP Options
- Method:Path:
/admin/v1/AppEntitlementCollections
- Remove an App Entitlement Collection
- Method: deletePath:
/admin/v1/AppEntitlementCollections/{id}
- Replace an App Entitlement Collection
- Method: putPath:
/admin/v1/AppEntitlementCollections/{id}
- Search App Entitlement Collections
- Method: getPath:
/admin/v1/AppEntitlementCollections
- Search App Entitlement Collections Using POST
- Method: postPath:
/admin/v1/AppEntitlementCollections/.search
- Update an App Entitlement Collection
- Method: patchPath:
/admin/v1/AppEntitlementCollections/{id}
Apps/App Kerberos Realm Updater
Updates the attributes in the Kerberos Realm of an App. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/AppKerberosRealmUpdater
- Replace the Kerberos Realm in an App
- Method: putPath:
/admin/v1/AppKerberosRealmUpdater/{id}
- Update the Kerberos Realm in an App
- Method: patchPath:
/admin/v1/AppKerberosRealmUpdater/{id}
Apps/App Roles
Manage AppRoles. An AppRole is an App-specific role that Oracle Identity Cloud Service maintains for an unmanaged application. Membership in each AppRole confers some privilege within that App. See Working with Apps for more information on granting appRoles to an application. When requesting AppRole members, it is recommended to use startIndex and count to return members in pages instead of in a single response, eg : #attributes=members[startIndex=1%26count=10]". This REST API is SCIM compliant.
- Create an AppRole
- Method: postPath:
/admin/v1/AppRoles
- Delete an AppRole
- Method: deletePath:
/admin/v1/AppRoles/{id}
- Get an AppRole
- Method: getPath:
/admin/v1/AppRoles/{id}
- HTTP Options
- Method:Path:
/admin/v1/AppRoles
- Search AppRoles
- Method: getPath:
/admin/v1/AppRoles
- Search AppRoles Using POST
- Method: postPath:
/admin/v1/AppRoles/.search
- Update an AppRole
- Method: patchPath:
/admin/v1/AppRoles/{id}
Apps/App Status Changer
Activate or deactivate an application by setting its active attribute to true or false. See Working with Apps for an example request to activate an application. This REST API is SCIM compliant.
- Activate/Deactivate an App
- Method: putPath:
/admin/v1/AppStatusChanger/{id}
- HTTP Options
- Method:Path:
/admin/v1/AppStatusChanger
Apps/App Templates
Manage application templates. An AppTemplate provides the default values for any App based on that template. See Working with Apps for example requests to create an application. This REST API is SCIM compliant.
- Create an AppTemplate
- Method: postPath:
/admin/v1/AppTemplates
- Delete an AppTemplate
- Method: deletePath:
/admin/v1/AppTemplates/{id}
- Get an AppTemplate
- Method: getPath:
/admin/v1/AppTemplates/{id}
- HTTP Options
- Method:Path:
/admin/v1/AppTemplates
- Replace an AppTemplate
- Method: putPath:
/admin/v1/AppTemplates/{id}
- Search AppTemplates
- Method: getPath:
/admin/v1/AppTemplates
- Search AppTemplates Using POST
- Method: postPath:
/admin/v1/AppTemplates/.search
- Update an AppTemplate
- Method: patchPath:
/admin/v1/AppTemplates/{id}
Apps/App Upgrader
Use this endpoint to upgrade an App. This REST API is SCIM compliant.
Added In Release: 17.4.6
Added In Release: 17.4.6
- HTTP Options
- Method:Path:
/admin/v1/AppUpgrader
- Upgrade an App
- Method: postPath:
/admin/v1/AppUpgrader
Apps/AppClient Secret Regenerator
Use this convenience endpoint to regenerate the Client Secret for an App. See Working with Apps for more information on creating and activating applications.
- HTTP Options
- Method:Path:
/admin/v1/AppClientSecretRegenerator
- Regenerate OAuth Client Secret
- Method: postPath:
/admin/v1/AppClientSecretRegenerator
- Regenerate OAuth Client Secret
- Method: getPath:
/admin/v1/AppClientSecretRegenerator/{id}
Apps/Apps
Manage Apps. An Oracle Identity Cloud Service App is an external software system or service instance for which Oracle Identity Cloud Service supports identity services, such as Identity Federation (SAML), Single Sign-On, User Provisioning, or OAuth2. See Working with Apps for more information on creating and activating applications. This REST API is SCIM compliant.
- Create an App
- Method: postPath:
/admin/v1/Apps
- Delete an App
- Method: deletePath:
/admin/v1/Apps/{id}
- Get an App
- Method: getPath:
/admin/v1/Apps/{id}
- HTTP Options
- Method:Path:
/admin/v1/Apps
- Replace an App
- Method: putPath:
/admin/v1/Apps/{id}
- Search Apps
- Method: getPath:
/admin/v1/Apps
- Search Apps Using POST
- Method: postPath:
/admin/v1/Apps/.search
- Update an App
- Method: patchPath:
/admin/v1/Apps/{id}
Apps/Connector Bundles
Use this endpoint to manage connector bundles.
- Create Connector Bundles
- Method: postPath:
/admin/v1/ConnectorBundles
- Delete Connector Bundles
- Method: deletePath:
/admin/v1/ConnectorBundles/{id}
- Get Connector Bundles
- Method: getPath:
/admin/v1/ConnectorBundles/{id}
- HTTP Options
- Method:Path:
/admin/v1/ConnectorBundles
- Search Connector Bundles
- Method: getPath:
/admin/v1/ConnectorBundles
- Search Connector Bundles Using POST
- Method: postPath:
/admin/v1/ConnectorBundles/.search
Apps/Custom Connector Info
Use this endpoint to manage custom connector info.
Added In Release: 20.1.3
Added In Release: 20.1.3
- Create CustomConnectorInfo
- Method: postPath:
/admin/v1/CustomConnectorInfos
- HTTP Options
- Method:Path:
/admin/v1/CustomConnectorInfos
Apps/Grant Converter
Use this endpoint to convert a Grant. This REST API is SCIM compliant.
Added In Release: 20.1.3
Added In Release: 20.1.3
- Convert a Grant
- Method: postPath:
/admin/v1/GrantConverter
- HTTP Options
- Method:Path:
/admin/v1/GrantConverter
Apps/Grant Evaluation Job Report
Use this endpoint to retrieve or search for a job report to view the status of a grant evaluation job. This REST API is SCIM compliant.
- Create a Managed Object Sync Job Status
- Method: postPath:
/job/v1/GrantEvaluationJobReports
- Delete a Grant Evaluation Job Report
- Method: deletePath:
/job/v1/GrantEvaluationJobReports/{id}
- Get a Managed Object Sync Job Status
- Method: getPath:
/job/v1/GrantEvaluationJobReports/{id}
- HTTP Options
- Method:Path:
/job/v1/GrantEvaluationJobReports
- Search Managed Object Sync Jobs
- Method: getPath:
/job/v1/GrantEvaluationJobReports
- Search Managed Object Sync Jobs Using POST
- Method: postPath:
/job/v1/GrantEvaluationJobReports/.search
Apps/Grants
Manage Grants. A Grant records the assignment of an entitlement, such as an AppRole, to a User or to a Group (or to an App). Creating a Grant of an AppRole adds the grantee as a member of that AppRole. Deleting a Grant of an AppRole removes the grantee as a member of that AppRole. This REST API is SCIM compliant. Note--In Oracle Identity Cloud Service v1, the value for the entitlement attributeName must be appRoles.
- Add a Grantee to an AppRole
- Method: postPath:
/admin/v1/Grants
- Get a Grant
- Method: getPath:
/admin/v1/Grants/{id}
- HTTP Options
- Method:Path:
/admin/v1/Grants
- Remove a Grantee from an AppRole
- Method: deletePath:
/admin/v1/Grants/{id}
- Search Grants
- Method: getPath:
/admin/v1/Grants
- Search Grants Using POST
- Method: postPath:
/admin/v1/Grants/.search
- Update a Grant
- Method: patchPath:
/admin/v1/Grants/{id}
Apps/Idcs AppRole Grants
Manage Oracle Identity Cloud Service AppRole Grants. An Oracle Identity Cloud Service AppRole Grant records the assignment of an Oracle Identity Cloud Service AppRole, to a User or to a Group (or to an App). Creating a Oracle Identity Cloud Service AppRole Grant adds the grantee as a member of that Oracle Identity Cloud Service AppRole. Deleting an Oracle Identity Cloud Service AppRole Grant removes the grantee as a member of that Oracle Identity Cloud Service AppRole. This REST API is SCIM compliant.
Added In Release: 19.2.1
Added In Release: 19.2.1
- Add a Grantee to an Oracle Identity Cloud Service AppRole
- Method: postPath:
/admin/v1/IdcsAppRoleGrants
- Get an Oracle Identity Cloud Service AppRole Grant
- Method: getPath:
/admin/v1/IdcsAppRoleGrants/{id}
- HTTP Options
- Method:Path:
/admin/v1/IdcsAppRoleGrants
- Remove a Grantee from an Oracle Identity Cloud Service AppRole
- Method: deletePath:
/admin/v1/IdcsAppRoleGrants/{id}
- Search Oracle Identity Cloud Service AppRole Grants
- Method: getPath:
/admin/v1/IdcsAppRoleGrants
- Search Oracle Identity Cloud Service AppRole Grants Using POST
- Method: postPath:
/admin/v1/IdcsAppRoleGrants/.search
- Update an Oracle Identity Cloud Service AppRole Grant
- Method: patchPath:
/admin/v1/IdcsAppRoleGrants/{id}
Apps/Local Connector Bundles
Use this endpoint to manage local connector bundles.
Added In Release: 20.1.3
Added In Release: 20.1.3
- Create Connector Bundles
- Method: postPath:
/admin/v1/LocalConnectorBundles
- Delete Connector Bundles
- Method: deletePath:
/admin/v1/LocalConnectorBundles/{id}
- Get Connector Bundles
- Method: getPath:
/admin/v1/LocalConnectorBundles/{id}
- HTTP Options
- Method:Path:
/admin/v1/LocalConnectorBundles
- Search Connector Bundles
- Method: getPath:
/admin/v1/LocalConnectorBundles
- Search Connector Bundles Using POST
- Method: postPath:
/admin/v1/LocalConnectorBundles/.search
Apps/Managed App Connection Tester
Test connectivity between Oracle Identity Cloud Service and the configured target. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/ManagedAppConnectionTester
- Test the Managed App Connection
- Method: putPath:
/admin/v1/ManagedAppConnectionTester/{id}
Apps/Managed App Operation Templates
Manage operations that are supported by a template of a connected managed app. This endpoint provides the default operations supported for any managed App that is based on that template. This REST API is SCIM compliant.
- Create a Managed App Operation Template
- Method: postPath:
/admin/v1/ManagedAppOperationTemplates
- Delete a Managed App Operation Template
- Method: deletePath:
/admin/v1/ManagedAppOperationTemplates/{id}
- Get a Managed App Operation Template
- Method: getPath:
/admin/v1/ManagedAppOperationTemplates/{id}
- HTTP Options
- Method:Path:
/admin/v1/ManagedAppOperationTemplates
- Replace a Managed App Operation Template
- Method: putPath:
/admin/v1/ManagedAppOperationTemplates/{id}
- Search Managed App Operation Templates
- Method: getPath:
/admin/v1/ManagedAppOperationTemplates
- Search Managed App Operation Templates Using POST
- Method: postPath:
/admin/v1/ManagedAppOperationTemplates/.search
- Update a Managed App Operation Template
- Method: patchPath:
/admin/v1/ManagedAppOperationTemplates/{id}
Apps/Managed App Operations
Manage operations that are supported by a connected managed app. This REST API is SCIM compliant.
- Get a Managed App Operation
- Method: getPath:
/admin/v1/ManagedAppOperations/{id}
- HTTP Options
- Method:Path:
/admin/v1/ManagedAppOperations
- Replace a Managed App Operation
- Method: putPath:
/admin/v1/ManagedAppOperations/{id}
- Search Managed App Operations
- Method: getPath:
/admin/v1/ManagedAppOperations
- Search Managed App Operations Using POST
- Method: postPath:
/admin/v1/ManagedAppOperations/.search
- Update a Managed App Operation
- Method: patchPath:
/admin/v1/ManagedAppOperations/{id}
Apps/Managed Object Class Templates
Use this endpoint to work with managed object class template configurations for a connected managed app. This REST API is SCIM compliant.
Added In Release: 18.1.6
Added In Release: 18.1.6
- Create a Managed ObjectClass Template
- Method: postPath:
/admin/v1/ManagedObjectClassTemplates
- Delete a Managed ObjectClass Template
- Method: deletePath:
/admin/v1/ManagedObjectClassTemplates/{id}
- Get a Managed ObjectClass Template
- Method: getPath:
/admin/v1/ManagedObjectClassTemplates/{id}
- HTTP Options
- Method:Path:
/admin/v1/ManagedObjectClassTemplates
- Replace a Managed ObjectClass Template
- Method: putPath:
/admin/v1/ManagedObjectClassTemplates/{id}
- Search Managed ObjectClass Templates
- Method: getPath:
/admin/v1/ManagedObjectClassTemplates
- Search Managed ObjectClass Templates Using POST
- Method: postPath:
/admin/v1/ManagedObjectClassTemplates/.search
- Update a Managed ObjectClass Template
- Method: patchPath:
/admin/v1/ManagedObjectClassTemplates/{id}
Apps/Managed Object Classes
Use this endpoint to work with managed object class configurations for a connected managed app. This REST API is SCIM compliant.
Added In Release: 18.1.6
Added In Release: 18.1.6
- Get a Managed ObjectClass
- Method: getPath:
/admin/v1/ManagedObjectClasses/{id}
- HTTP Options
- Method:Path:
/admin/v1/ManagedObjectClasses
- Replace a Managed ObjectClass
- Method: putPath:
/admin/v1/ManagedObjectClasses/{id}
- Search Managed ObjectClasses
- Method: getPath:
/admin/v1/ManagedObjectClasses
- Search Managed ObjectClasses Using POST
- Method: postPath:
/admin/v1/ManagedObjectClasses/.search
- Update a Managed ObjectClass
- Method: patchPath:
/admin/v1/ManagedObjectClasses/{id}
Apps/Managed Object Sync Detailed Job Report
Use this endpoint to retrieve or search for a job report to view the details of a managed object sync job. This REST API is SCIM compliant.
- Create a Managed Object Sync Job Status
- Method: postPath:
/job/v1/ManagedObjectSyncDetailedJobReports
- Delete a Managed Object Sync Detailed Job Status
- Method: deletePath:
/job/v1/ManagedObjectSyncDetailedJobReports/{id}
- Get a Managed Object Sync Job Status
- Method: getPath:
/job/v1/ManagedObjectSyncDetailedJobReports/{id}
- HTTP Options
- Method:Path:
/job/v1/ManagedObjectSyncDetailedJobReports
- Search Managed Object Sync Jobs
- Method: getPath:
/job/v1/ManagedObjectSyncDetailedJobReports
- Search Managed Object Sync Jobs Using POST
- Method: postPath:
/job/v1/ManagedObjectSyncDetailedJobReports/.search
Apps/Managed Object Sync Job Report
Use this endpoint to retrieve or search for a job report to view the status of a managed object sync job. This REST API is SCIM compliant.
- Create a Managed Object Sync Job Status
- Method: postPath:
/job/v1/ManagedObjectSyncJobReports
- Delete a Managed Object Sync Job Report
- Method: deletePath:
/job/v1/ManagedObjectSyncJobReports/{id}
- Get a Managed Object Sync Job Status
- Method: getPath:
/job/v1/ManagedObjectSyncJobReports/{id}
- HTTP Options
- Method:Path:
/job/v1/ManagedObjectSyncJobReports
- Search Managed Object Sync Jobs
- Method: getPath:
/job/v1/ManagedObjectSyncJobReports
- Search Managed Object Sync Jobs Using POST
- Method: postPath:
/job/v1/ManagedObjectSyncJobReports/.search
Apps/Mapped Action Templates
Use this endpoint to configure the propagation of actions from Oracle Identity Cloud Service Resources to Managed Objects and from Managed Objects to Resources. This REST API is SCIM compliant.
Added In Release: 17.4.6
Added In Release: 17.4.6
- Create a Mapped Action Template
- Method: postPath:
/admin/v1/MappedActionTemplates
- Delete a Mapped Action Template
- Method: deletePath:
/admin/v1/MappedActionTemplates/{id}
- Get a Mapped Action Template
- Method: getPath:
/admin/v1/MappedActionTemplates/{id}
- HTTP Options
- Method:Path:
/admin/v1/MappedActionTemplates
- Replace a Mapped Action Template
- Method: putPath:
/admin/v1/MappedActionTemplates/{id}
- Search Account ObjectClass Templates Using POST
- Method: postPath:
/admin/v1/MappedActionTemplates/.search
- Search Mapped Action Templates
- Method: getPath:
/admin/v1/MappedActionTemplates
- Update a Mapped Action Template
- Method: patchPath:
/admin/v1/MappedActionTemplates/{id}
Apps/Mapped Actions
Use this endpoint to configure the propagation of actions from Oracle Identity Cloud Service Resources to Managed Objects and from Managed Objects to Resources. This REST API is SCIM compliant.
Added In Release: 17.4.6
Added In Release: 17.4.6
- Create a Mapped Action
- Method: postPath:
/admin/v1/MappedActions
- Delete a Mapped Action
- Method: deletePath:
/admin/v1/MappedActions/{id}
- Get a Mapped Action
- Method: getPath:
/admin/v1/MappedActions/{id}
- HTTP Options
- Method:Path:
/admin/v1/MappedActions
- Replace a Mapped Action
- Method: putPath:
/admin/v1/MappedActions/{id}
- Search Account ObjectClass Templates POST
- Method: postPath:
/admin/v1/MappedActions/.search
- Search Mapped Actions
- Method: getPath:
/admin/v1/MappedActions
- Update a Mapped Action
- Method: patchPath:
/admin/v1/MappedActions/{id}
Apps/Mapped Attribute Templates
Use this endpoint to manage templates for mapped attributes of an Oracle Identity Cloud Service resource type and attributes of the Managed Object class templates either inbound or outbound. This REST API is SCIM compliant.
Added In Release: 17.3.6
Added In Release: 17.3.6
- Create a Mapped Attribute Template
- Method: postPath:
/admin/v1/MappedAttributeTemplates
- Get Attribute Mappings for a Mapped Attribute Template
- Method: getPath:
/admin/v1/MappedAttributeTemplates/{id}
- HTTP Options
- Method:Path:
/admin/v1/MappedAttributeTemplates
- Replace a Mapped Attribute Template
- Method: putPath:
/admin/v1/MappedAttributeTemplates/{id}
- Search Mapped Attribute Templates
- Method: getPath:
/admin/v1/MappedAttributeTemplates
- Search Mapped Attribute Templates Using POST
- Method: postPath:
/admin/v1/MappedAttributeTemplates/.search
- Update a Mapped Attribute Template
- Method: patchPath:
/admin/v1/MappedAttributeTemplates/{id}
Apps/Mapped Attributes
Use this endpoint to manage mapped attributes of an Oracle Identity Cloud Service resource type and attributes of the Managed Object class either inbound or outbound. This REST API is SCIM compliant.
Added In Release: 17.3.6
Added In Release: 17.3.6
- Get Attribute Mappings for a Mapped Attribute
- Method: getPath:
/admin/v1/MappedAttributes/{id}
- HTTP Options
- Method:Path:
/admin/v1/MappedAttributes
- Replace a Mapped Attribute
- Method: putPath:
/admin/v1/MappedAttributes/{id}
- Search Mapped Attributes
- Method: getPath:
/admin/v1/MappedAttributes
- Search Mapped Attributes Using POST
- Method: postPath:
/admin/v1/MappedAttributes/.search
- Update a Mapped Attribute
- Method: patchPath:
/admin/v1/MappedAttributes/{id}
Apps/Pending Action
Use this endpoint to manage Pending Actions.
Added In Release: 20.1.3
Added In Release: 20.1.3
- Get PendingAction
- Method: getPath:
/admin/v1/PendingActions/{id}
- HTTP Options
- Method:Path:
/admin/v1/PendingActions
- Search PendingAction
- Method: getPath:
/admin/v1/PendingActions
- Search PendingAction Using POST
- Method: postPath:
/admin/v1/PendingActions/.search
Apps/Pending Action Executor
Use this endpoint to execute Pending Actions.
Added In Release: 20.1.3
Added In Release: 20.1.3
- Execute the Pending Action
- Method: postPath:
/admin/v1/PendingActionExecutor
- HTTP Options
- Method:Path:
/admin/v1/PendingActionExecutor
Apps/Web Tier Policy JSON Validator
Use this convenience endpoint to validate the WebTier Policy JSON. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/WebTierPolicyJsonValidator
- Validate WebTier Policy JSON
- Method: postPath:
/admin/v1/WebTierPolicyJsonValidator
Audit/Audit Events
Audit logs for Oracle Identity Cloud Services. Audit events capture all significant events, changes, or actions. This REST API is SCIM compliant.
- Get an Audit Event
- Method: getPath:
/admin/v1/AuditEvents/{id}
- HTTP Options
- Method:Path:
/admin/v1/AuditEvents
- Search Audit Events
- Method: getPath:
/admin/v1/AuditEvents
- Search Audit Events Using POST
- Method: postPath:
/admin/v1/AuditEvents/.search
Audit/User Audit Events Purger
Use this endpoint to delete all of the audit events that are related to a deleted user.
Added In Release: 18.2.4
Added In Release: 18.2.4
- Delete Audit Events by User ID
- Method: postPath:
/admin/v1/UserAuditEventsPurger
- HTTP Options
- Method:Path:
/admin/v1/UserAuditEventsPurger
Authenticate/Authenticate
Use this endpoint to complete the authentication process.
- Complete Authentication and Obtain an Authentication Token
- Method: postPath:
/sso/v1/sdk/authenticate
- HTTP Options
- Method:Path:
/sso/v1/sdk/authenticate
- Initiate Authentication
- Method: getPath:
/sso/v1/sdk/authenticate
Authenticate/IdP
Use this endpoint to initiate the flow to authenticate using a remote Identity Provider.
- HTTP Options
- Method:Path:
/sso/v1/sdk/idp
- HTTP Options
- Method:Path:
/sso/v1/sdk/secure/idp
- Initiate Authentication Using a Remote IdP
- Method: postPath:
/sso/v1/sdk/idp
- Initiate Authentication Using a Remote IdP
- Method: postPath:
/sso/v1/sdk/secure/idp
Authenticate/Session
Use this endpoint to initiate the flow to start a session using either the requestState or an authnToken that you obtained from the previous authentication call to the /authenticate endpoint.
- HTTP Options
- Method:Path:
/sso/v1/sdk/secure/session
- HTTP Options
- Method:Path:
/sso/v1/sdk/session
- Start a Session
- Method: postPath:
/sso/v1/sdk/secure/session
- Start a Session
- Method: postPath:
/sso/v1/sdk/session
Bulk/Bulk
Make bulk requests to create, replace, update, delete resources of any type. Enables clients to send a potentially large collection of resource operations in a single request. This REST API is SCIM compliant.
Latest Version: 1
Earliest Version: 1
Latest Version: 1
Earliest Version: 1
- Create a Bulk Request
- Method: postPath:
/admin/v1/Bulk
- HTTP Options
- Method:Path:
/admin/v1/Bulk
Bulk/Bulk User Password Changer
Use to reset user passwords to a commonly known password for all valid user IDs in a list or for all tenant users by setting the all attribute to true. This REST API is SCIM compliant.
- Bulk change user passwords to common password
- Method: postPath:
/admin/v1/BulkUserPasswordChanger
- HTTP Options
- Method:Path:
/admin/v1/BulkUserPasswordChanger
Bulk/Bulk User Password Resetter
Use to assign a new randomly generated password (using the configured Password Policy) for all valid user IDs in a list or for all tenant users by setting the all attribute to true. This REST API is SCIM compliant.
- Bulk Reset User Passwords
- Method: postPath:
/admin/v1/BulkUserPasswordResetter
- HTTP Options
- Method:Path:
/admin/v1/BulkUserPasswordResetter
Cloud Gate/Cloud Gate Definition
Use this endpoint to store Cloud Gate configurations. This REST API is SCIM compliant.
Added In Release: 19.1.4
Added In Release: 19.1.4
- Create a Cloud Gate
- Method: postPath:
/admin/v1/CloudGates
- Delete a Cloud Gate
- Method: deletePath:
/admin/v1/CloudGates/{id}
- Get a Cloud Gate
- Method: getPath:
/admin/v1/CloudGates/{id}
- HTTP Options
- Method:Path:
/admin/v1/CloudGates
- Replace a Cloud Gate
- Method: putPath:
/admin/v1/CloudGates/{id}
- Search Cloud Gates
- Method: getPath:
/admin/v1/CloudGates
- Search Cloud Gates Using POST
- Method: postPath:
/admin/v1/CloudGates/.search
- Update a Cloud Gate
- Method: patchPath:
/admin/v1/CloudGates/{id}
Cloud Gate/Cloud Gate Mappings
Use this endpoint to store Cloud Gate mappings. This REST API is SCIM compliant.
Added In Release: 19.2.1
Added In Release: 19.2.1
- Create a Cloud Gate mapping
- Method: postPath:
/admin/v1/CloudGateMappings
- Delete a Cloud Gate mapping
- Method: deletePath:
/admin/v1/CloudGateMappings/{id}
- Get a Cloud Gate mapping
- Method: getPath:
/admin/v1/CloudGateMappings/{id}
- HTTP Options
- Method:Path:
/admin/v1/CloudGateMappings
- Replace a Cloud Gate mapping
- Method: putPath:
/admin/v1/CloudGateMappings/{id}
- Search Cloud Gate mappings
- Method: getPath:
/admin/v1/CloudGateMappings
- Search Cloud Gate mappings Using POST
- Method: postPath:
/admin/v1/CloudGateMappings/.search
- Update a Cloud Gate mapping
- Method: patchPath:
/admin/v1/CloudGateMappings/{id}
Cloud Gate/Cloud Gate Servers
Use this endpoint to store Cloud Gate server block configurations. This configuration will be transformed to nginx server block configuration. This REST API is SCIM compliant.
Added In Release: 19.2.1
Added In Release: 19.2.1
- Create a Cloud Gate server
- Method: postPath:
/admin/v1/CloudGateServers
- Delete a Cloud Gate server
- Method: deletePath:
/admin/v1/CloudGateServers/{id}
- Get a Cloud Gate server
- Method: getPath:
/admin/v1/CloudGateServers/{id}
- HTTP Options
- Method:Path:
/admin/v1/CloudGateServers
- Replace a Cloud Gate server
- Method: putPath:
/admin/v1/CloudGateServers/{id}
- Search Cloud Gate servers
- Method: getPath:
/admin/v1/CloudGateServers
- Search Cloud Gate servers Using POST
- Method: postPath:
/admin/v1/CloudGateServers/.search
- Update a Cloud Gate server
- Method: patchPath:
/admin/v1/CloudGateServers/{id}
Cloud Gate/Cloud Gate Settings
Use this endpoint to manage tenant-specific Cloud Gate settings. This REST API is SCIM compliant.
There is a single pre-seeded instance of CloudGateSettings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
Added In Release: 19.1.4
There is a single pre-seeded instance of CloudGateSettings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
Added In Release: 19.1.4
- Get Cloud Gate Settings
- Method: getPath:
/admin/v1/CloudGateSettings/{id}
- HTTP Options
- Method:Path:
/admin/v1/CloudGateSettings
- Replace Cloud Gate Settings
- Method: putPath:
/admin/v1/CloudGateSettings/{id}
- Search Cloud Gate Settings
- Method: getPath:
/admin/v1/CloudGateSettings
- Update Cloud Gate Settings
- Method: patchPath:
/admin/v1/CloudGateSettings/{id}
Cloud Gate/Cloud Gate Upstream Server Groups
Use this endpoint to store Cloud Gate upstream server groups. This configuration will be transformed to nginx upstream configuration. This REST API is SCIM compliant.
Added In Release: 20.1.3
Added In Release: 20.1.3
- Create a Cloud Gate upstream server group
- Method: postPath:
/admin/v1/CloudGateUpstreamServerGroups
- Delete a Cloud Gate upstream server group
- Method: deletePath:
/admin/v1/CloudGateUpstreamServerGroups/{id}
- Get a Cloud Gate upstream server group
- Method: getPath:
/admin/v1/CloudGateUpstreamServerGroups/{id}
- HTTP Options
- Method:Path:
/admin/v1/CloudGateUpstreamServerGroups
- Replace a Cloud Gate upstream server group
- Method: putPath:
/admin/v1/CloudGateUpstreamServerGroups/{id}
- Search Cloud Gate upstream server group
- Method: getPath:
/admin/v1/CloudGateUpstreamServerGroups
- Search Cloud Gate upstream server group Using POST
- Method: postPath:
/admin/v1/CloudGateUpstreamServerGroups/.search
- Update a Cloud Gate upstream server group
- Method: patchPath:
/admin/v1/CloudGateUpstreamServerGroups/{id}
Cloud Gate/Cloud Gate Upstream Servers
Use this endpoint to store Cloud Gate upstream server configurations. This REST API is SCIM compliant.
Added In Release: 20.1.3
Added In Release: 20.1.3
- Create a Cloud Gate upstream server
- Method: postPath:
/admin/v1/CloudGateUpstreamServers
- Delete a Cloud Gate upstream server
- Method: deletePath:
/admin/v1/CloudGateUpstreamServers/{id}
- Get a Cloud Gate upstream server
- Method: getPath:
/admin/v1/CloudGateUpstreamServers/{id}
- HTTP Options
- Method:Path:
/admin/v1/CloudGateUpstreamServers
- Replace a Cloud Gate upstream server
- Method: putPath:
/admin/v1/CloudGateUpstreamServers/{id}
- Search Cloud Gate upstream server
- Method: getPath:
/admin/v1/CloudGateUpstreamServers
- Search Cloud Gate upstream server Using POST
- Method: postPath:
/admin/v1/CloudGateUpstreamServers/.search
- Update a Cloud Gate upstream server
- Method: patchPath:
/admin/v1/CloudGateUpstreamServers/{id}
Common/Allowed Values
Maintains a list of valid values for attributes. The UI and the server validate attribute values such as Country, Locale, Timezone, and so on against this list. This REST API is SCIM compliant.
- Define Allowed Values
- Method: postPath:
/admin/v1/AllowedValues
- Delete an Allowed Value
- Method: deletePath:
/admin/v1/AllowedValues/{id}
- Get Allowed Values
- Method: getPath:
/admin/v1/AllowedValues/{id}
- HTTP Options
- Method:Path:
/admin/v1/AllowedValues
- Replace an Allowed Value
- Method: putPath:
/admin/v1/AllowedValues/{id}
- Search Allowed Values
- Method: getPath:
/admin/v1/AllowedValues
- Search Allowed Values Using POST
- Method: postPath:
/admin/v1/AllowedValues/.search
- Update an Allowed Value
- Method: patchPath:
/admin/v1/AllowedValues/{id}
Common/Branding Settings
Maintains customized company logo, company name, login text, default locale, and so on. Provides minimal information that is required for the UI login page. This REST API is SCIM compliant.
There is a single pre-seeded instance of BrandingSettings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
There is a single pre-seeded instance of BrandingSettings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
- Get Branding Settings
- Method: getPath:
/admin/v1/BrandingSettings/{id}
- HTTP Options
- Method:Path:
/admin/v1/BrandingSettings
- Search Branding Settings
- Method: getPath:
/admin/v1/BrandingSettings
Common/Custom Allowed Values
Maintains a list of custom allowed values for attributes. The UI and the server validate attribute values such as Country, Locale, Timezone, and so on against this list. This REST API is SCIM compliant.
Added In Release: 17.4.6
Added In Release: 17.4.6
- Get a Custom Allowed Value
- Method: getPath:
/admin/v1/CustomAllowedValues/{id}
- HTTP Options
- Method:Path:
/admin/v1/CustomAllowedValues
- Replace a Custom Allowed Value
- Method: putPath:
/admin/v1/CustomAllowedValues/{id}
- Search Custom Allowed Values
- Method: getPath:
/admin/v1/CustomAllowedValues
- Search Custom Allowed Values Using POST
- Method: postPath:
/admin/v1/CustomAllowedValues/.search
- Update a Custom Allowed Value
- Method: patchPath:
/admin/v1/CustomAllowedValues/{id}
Common/Custom Claims
Use this endpoint to get Custom Claims defined for a tenant
Added In Release: 19.2.1
Added In Release: 19.2.1
- Get a Custom Claim
- Method: getPath:
/admin/v1/CustomClaims/{id}
- HTTP Options
- Method:Path:
/admin/v1/CustomClaims
- Replace a Custom Claim
- Method: putPath:
/admin/v1/CustomClaims/{id}
- Search Custom Claims
- Method: getPath:
/admin/v1/CustomClaims
- Search Custom Claims Using POST
- Method: postPath:
/admin/v1/CustomClaims/.search
- Update a Custom Claim
- Method: patchPath:
/admin/v1/CustomClaims/{id}
Common/Exportable Resource Types
Use this endpoint to get list of Resource Types Exportable for given file Type either CSV or JSON.
Added In Release: 19.1.4
Added In Release: 19.1.4
- HTTP Options
- Method:Path:
/admin/v1/ExportableResourceTypes
- Post Search to get the list of Resource Types Exportable for given file Type either CSV or JSON
- Method: postPath:
/admin/v1/ExportableResourceTypes/.search
- Search to get the list of Resource Types Exportable for given file Type either CSV or JSON
- Method: getPath:
/admin/v1/ExportableResourceTypes
Common/Feature
This endpoint allows you to manage a feature you can enable or disable within a region. This endpoint is SCIM compliant.
Added In Release: 19.2.1
Added In Release: 19.2.1
- Create a Feature
- Method: postPath:
/admin/v1/Features
- Get a Feature
- Method: getPath:
/admin/v1/Features/{id}
- HTTP Options
- Method:Path:
/admin/v1/Features
- Search for Features
- Method: getPath:
/admin/v1/Features
- Search for Features
- Method: postPath:
/admin/v1/Features/.search
- Update a Feature
- Method: patchPath:
/admin/v1/Features/{id}
Common/Feature Info
This endpoints allows querying for the effective state of features. This endpoint is SCIM compliant.
Added In Release: 19.2.1
Added In Release: 19.2.1
- Get a Feature
- Method: getPath:
/admin/v1/FeatureInfos/{id}
- HTTP Options
- Method:Path:
/admin/v1/FeatureInfos
- Search for Features
- Method: getPath:
/admin/v1/FeatureInfos
- Search for Features
- Method: postPath:
/admin/v1/FeatureInfos/.search
Common/Latest Binary File Information Based On Version
Use this endpoint to retrieve the latest version of binary file information.
Added In Release: 18.1.2
Added In Release: 18.1.2
- HTTP Options
- Method:Path:
/admin/v1/LatestBinaryFileInfoVersionRetriever
- Search for Binary File Meta Data Info
- Method: getPath:
/admin/v1/LatestBinaryFileInfoVersionRetriever
- Search for Binary File Meta Data Info Using POST
- Method: postPath:
/admin/v1/LatestBinaryFileInfoVersionRetriever/.search
Common/Resource Type Schema Attributes
Use this endpoint to search on resource type for a flattened list of schema attributes
Added In Release: 17.4.6
Added In Release: 17.4.6
- HTTP Options
- Method:Path:
/admin/v1/ResourceTypeSchemaAttributes
- Search Resource Type Schema Attributes
- Method: getPath:
/admin/v1/ResourceTypeSchemaAttributes
- Search Resource Type Schema Attributes Using POST
- Method: postPath:
/admin/v1/ResourceTypeSchemaAttributes/.search
Common/Resource Types
Maintains the definition of resource types that are supported by Oracle Identity Cloud Service. Resource type definitions contain standard SCIM resource type attributes and additional Oracle Identity Cloud Service-specific attributes such as provider details, supported operations, cacheable, and so on. This REST API is SCIM compliant.
- Get a Resource Type
- Method: getPath:
/admin/v1/ResourceTypes/{id}
- HTTP Options
- Method:Path:
/admin/v1/ResourceTypes
- Search Resource Types
- Method: getPath:
/admin/v1/ResourceTypes
- Search Resource Types Using POST
- Method: postPath:
/admin/v1/ResourceTypes/.search
Common/Schemas
Maintains the schema definition of resource types that are supported by Oracle Identity Cloud Service. Schema definitions contain standard SCIM schema attributes and additional Oracle Identity Cloud Service-specific attributes such as searchable, min/max length for validation, target attrname, and so on. This REST API is SCIM compliant.
- Get a Schema
- Method: getPath:
/admin/v1/Schemas/{id}
- HTTP Options
- Method:Path:
/admin/v1/Schemas
- Replace a Schema Def
- Method: putPath:
/admin/v1/Schemas/{id}
- Search Schemas
- Method: getPath:
/admin/v1/Schemas
- Search Schemas Using POST
- Method: postPath:
/admin/v1/Schemas/.search
- Update a Schema Def
- Method: patchPath:
/admin/v1/Schemas/{id}
Common/Service Provider Configurations
Enables clients to discover SCIM specification features that are supported by Oracle Identity Cloud Service as well as provide additional implementation details. This REST API is SCIM compliant.
There is a single pre-seeded instance of ServiceProviderConfig in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
There is a single pre-seeded instance of ServiceProviderConfig in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
- Get a Service Provider Config
- Method: getPath:
/admin/v1/ServiceProviderConfig/{id}
- HTTP Options
- Method:Path:
/admin/v1/ServiceProviderConfig
- Search Service Provider Configs
- Method: getPath:
/admin/v1/ServiceProviderConfig
Common/Settings
Maintains a customized company logo, company name, login text, default locale, and so on. Oracle Customer Service Reps access permission is also maintained here. This REST API is SCIM compliant.
There is a single pre-seeded instance of Settings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
There is a single pre-seeded instance of Settings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
- Get Settings
- Method: getPath:
/admin/v1/Settings/{id}
- HTTP Options
- Method:Path:
/admin/v1/Settings
- Replace Settings
- Method: putPath:
/admin/v1/Settings/{id}
- Search Settings
- Method: getPath:
/admin/v1/Settings
- Search Settings Using POST
- Method: postPath:
/admin/v1/Settings/.search
- Update a Setting
- Method: patchPath:
/admin/v1/Settings/{id}
Common/Tags
Use this endpoint to get a catalog of all tags in Oracle Identity Cloud Service.
Added In Release: 17.4.6
Added In Release: 17.4.6
- Get a Tag
- Method: getPath:
/admin/v1/Tags/{id}
- HTTP Options
- Method:Path:
/admin/v1/Tags
- Search Tags
- Method: getPath:
/admin/v1/Tags
- Search Tags Using POST
- Method: postPath:
/admin/v1/Tags/.search
Common/Tenant Feature State
This endpoint allows you to enable or disable one or more features for a tenant.
Added In Release: 19.2.1
Added In Release: 19.2.1
- Create a Tenant Feature State
- Method: postPath:
/admin/v1/TenantFeatureStates
- Get a Tenant Feature State
- Method: getPath:
/admin/v1/TenantFeatureStates/{id}
- HTTP Options
- Method:Path:
/admin/v1/TenantFeatureStates
- Search for Tenant Feature State
- Method: getPath:
/admin/v1/TenantFeatureStates
- Update a Tenant Feature State
- Method: patchPath:
/admin/v1/TenantFeatureStates/{id}
Common/User Attributes Settings
Use this endpoint to set the User schema attribute. This REST API is SCIM compliant
Added In Release: 19.1.4
Added In Release: 19.1.4
- Get User Schema Attribute Settings
- Method: getPath:
/admin/v1/UserAttributesSettings/{id}
- HTTP Options
- Method:Path:
/admin/v1/UserAttributesSettings
- Search User Schema Attribute Settings
- Method: getPath:
/admin/v1/UserAttributesSettings
- Search User Schema Attribute Settings Using POST
- Method: postPath:
/admin/v1/UserAttributesSettings/.search
- Update User Schema Attribute Settings
- Method: patchPath:
/admin/v1/UserAttributesSettings/{id}
Discovery/IDCS Discovery Docs
Access metadata and service endpoint URLs to configure Oracle Identity Cloud Service. This information helps to configure applications (that integrate with external services) with the necessary endpoints and to keep that configuration up-to-date. This endpoint requires a content type of text/html.
- HTTP Options
- Method:Path:
/.well-known/idcs-configuration
- Retrieve IDCS Discovery Doc
- Method: getPath:
/.well-known/idcs-configuration
Discovery/OpenID Discovery Docs
Access metadata and service endpoint URLs to configure OpenID Connect. This information helps to configure applications (that integrate with external services) with the necessary endpoints and to keep that configuration up-to-date. This endpoint requires a content type of text/html.
- HTTP Options
- Method:Path:
/.well-known/openid-configuration
- Retrieve OpenID Discovery Doc
- Method: getPath:
/.well-known/openid-configuration
IDBridge/IDBridge Configuration
Use this endpoint to replace or update an IDBridge Configuration. For example, replacing or updating a new feature name and the release in which the feature was introduced.
Added In Release: 18.1.6
Added In Release: 18.1.6
- Get an IDBridge Config
- Method: getPath:
/admin/v1/IDBridgeConfig/{id}
- HTTP Options
- Method:Path:
/admin/v1/IDBridgeConfig
- Replace an IDBridge Config
- Method: putPath:
/admin/v1/IDBridgeConfig/{id}
- Search for IDBridge Configs
- Method: getPath:
/admin/v1/IDBridgeConfig
- Search for IDBridge Configs Using POST
- Method: postPath:
/admin/v1/IDBridgeConfig/.search
- Update an IDBridge Config
- Method: patchPath:
/admin/v1/IDBridgeConfig/{id}
IDBridge/Test Delegated Authentication
Use this endpoint to test target authentication.
Added In Release: 18.1.6
Added In Release: 18.1.6
- HTTP Options
- Method:Path:
/admin/v1/TargetAuthenticationTester
- Test Target Authentication
- Method: postPath:
/admin/v1/TargetAuthenticationTester
Identity/Account Recovery Settings
Manage tenant-specific account recovery settings
Added In Release: 19.1.4
Added In Release: 19.1.4
- Get Account Recovery Settings
- Method: getPath:
/admin/v1/AccountRecoverySettings/{id}
- HTTP Options
- Method:Path:
/admin/v1/AccountRecoverySettings
- Replace Account Recovery Settings
- Method: putPath:
/admin/v1/AccountRecoverySettings/{id}
- Search Account Recovery Settings
- Method: getPath:
/admin/v1/AccountRecoverySettings
- Update Account Recovery Settings
- Method: patchPath:
/admin/v1/AccountRecoverySettings/{id}
Identity/Api Keys
Manage user's api key. This REST API is SCIM compliant.
Added In Release: 2009232244
Added In Release: 2009232244
- Add a user's api key
- Method: postPath:
/admin/v1/ApiKeys
- Delete user's api key
- Method: deletePath:
/admin/v1/ApiKeys/{id}
- Get user's api key
- Method: getPath:
/admin/v1/ApiKeys/{id}
- HTTP Options
- Method:Path:
/admin/v1/ApiKeys
- Search Api Key
- Method: getPath:
/admin/v1/ApiKeys
- Search ApiKeys Using POST
- Method: postPath:
/admin/v1/ApiKeys/.search
- Update user's api key
- Method: patchPath:
/admin/v1/ApiKeys/{id}
Identity/Applicable Password Policy Retriever
Use this endpoint to retrieve the password policy that is applicable for a user. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/ApplicablePasswordPolicyRetriever
- Retrieve an Applicable Password Policy for a User
- Method: postPath:
/admin/v1/ApplicablePasswordPolicyRetriever
Identity/Asserter
Use to assert the user or an app using the attribute value, and then return details about the user or app. This REST API is SCIM compliant.
- Assert Claims for a User or App
- Method: postPath:
/admin/v1/Asserter
- HTTP Options
- Method:Path:
/admin/v1/Asserter
Identity/Auth Tokens
Manage user's auth token. This REST API is SCIM compliant.
Added In Release: 2009232244
Added In Release: 2009232244
- Add a user's auth token
- Method: postPath:
/admin/v1/AuthTokens
- Delete user's auth token
- Method: deletePath:
/admin/v1/AuthTokens/{id}
- Get user's auth token
- Method: getPath:
/admin/v1/AuthTokens/{id}
- HTTP Options
- Method:Path:
/admin/v1/AuthTokens
- Search AuthTokens
- Method: getPath:
/admin/v1/AuthTokens
- Search AuthTokens Using POST
- Method: postPath:
/admin/v1/AuthTokens/.search
- Update user's AuthToken
- Method: patchPath:
/admin/v1/AuthTokens/{id}
Identity/Customer Secret Keys
Manage user's customer secret key. This REST API is SCIM compliant.
Added In Release: 2009232244
Added In Release: 2009232244
- Add a user's customer secret key
- Method: postPath:
/admin/v1/CustomerSecretKeys
- Delete user's customer secret key
- Method: deletePath:
/admin/v1/CustomerSecretKeys/{id}
- Get user's customer secret key
- Method: getPath:
/admin/v1/CustomerSecretKeys/{id}
- HTTP Options
- Method:Path:
/admin/v1/CustomerSecretKeys
- Search CustomerSecretKeys Using POST
- Method: postPath:
/admin/v1/CustomerSecretKeys/.search
- Search user's customer secret key
- Method: getPath:
/admin/v1/CustomerSecretKeys
- Update user's customer secret key
- Method: patchPath:
/admin/v1/CustomerSecretKeys/{id}
Identity/DBGroups
Manage all group administrative tasks. A group contains one or more users and works as a role for the enterprise to apply security features. This REST API is SCIM compliant.
Added In Release: 18.2.4
Added In Release: 18.2.4
- Get a DB Group
- Method: getPath:
/admin/v1/DBGroups/{id}
- HTTP Options
- Method:Path:
/admin/v1/DBGroups
- Search DB Groups
- Method: getPath:
/admin/v1/DBGroups
- Search DB Groups Using POST
- Method: postPath:
/admin/v1/DBGroups/.search
Identity/Diagnostic Records
Read or search diagnostic records. Oracle Identity Cloud Service emits diagnostic records when diagnostics are enabled. Diagnostic records are intended primarily to assist customers with investigating and resolving unexpected behavior--for example, due to the values of administrative settings. This REST API is SCIM compliant.
- Get a Diagnostic Record
- Method: getPath:
/admin/v1/DiagnosticRecords/{id}
- HTTP Options
- Method:Path:
/admin/v1/DiagnosticRecords
- Search Diagnostic Records
- Method: getPath:
/admin/v1/DiagnosticRecords
- Search Diagnostic Records Using POST
- Method: postPath:
/admin/v1/DiagnosticRecords/.search
Identity/DynamicResourceGroup
A Dynamic Resource Group matches any number of resources in OCI, including any number of AppServices or Apps in a Domain. IAM Policy can treat a Dynamic Resource Group as a Principal or as a target -- that is, as a subject who has access, as the object to be accessed, or both. This REST API is SCIM compliant.
Added In Release: 2009232244
Added In Release: 2009232244
- Create a DynamicResourceGroup
- Method: postPath:
/admin/v1/DynamicResourceGroups
- Delete a DynamicResourceGroup
- Method: deletePath:
/admin/v1/DynamicResourceGroups/{id}
- Get a DynamicResourceGroup
- Method: getPath:
/admin/v1/DynamicResourceGroups/{id}
- HTTP Options
- Method:Path:
/admin/v1/DynamicResourceGroups
- Replace a DynamicResourceGroup
- Method: putPath:
/admin/v1/DynamicResourceGroups/{id}
- Search DynamicResourceGroups
- Method: getPath:
/admin/v1/DynamicResourceGroups
- Search DynamicResourceGroups Using POST
- Method: postPath:
/admin/v1/DynamicResourceGroups/.search
- Update a DynamicResourceGroup
- Method: patchPath:
/admin/v1/DynamicResourceGroups/{id}
Identity/Groups
Manage all group administrative tasks. A group contains one or more users and works as a role for the enterprise to apply security features.When requesting Group members, a max of 10,000 members will be returned in a single request. If there are more than 10,000 members, the members request will fail. It is recommended to use startIndex and count to return members in pages instead of in a single response, eg : #attributes=members[startIndex=1%26count=10]. This REST API is SCIM compliant.
- Create a Group
- Method: postPath:
/admin/v1/Groups
- Delete a Group
- Method: deletePath:
/admin/v1/Groups/{id}
- 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
- Method: getPath:
/admin/v1/Groups/{id}
- HTTP Options
- Method:Path:
/admin/v1/Groups
- Replace a Group
- Method: putPath:
/admin/v1/Groups/{id}
- Search Groups Using POST
- Method: postPath:
/admin/v1/Groups/.search
- 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
- Method: getPath:
/admin/v1/Groups
- Update a Group
- Method: patchPath:
/admin/v1/Groups/{id}
Identity/Identity Config
Manage the global identity configuration that applies to all tenants. This REST API is SCIM compliant.
There is a single pre-seeded instance of IdentityConfig in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
Added In Release: 19.2.1
There is a single pre-seeded instance of IdentityConfig in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
Added In Release: 19.2.1
- Get an Identity Config
- Method: getPath:
/admin/v1/IdentityConfig/{id}
- HTTP Options
- Method:Path:
/admin/v1/IdentityConfig
- Replace an Identity Config
- Method: putPath:
/admin/v1/IdentityConfig/{id}
- Search for Identity Configs
- Method: getPath:
/admin/v1/IdentityConfig
- Search for Identity Configs Using POST
- Method: postPath:
/admin/v1/IdentityConfig/.search
- Update an Identity Config
- Method: patchPath:
/admin/v1/IdentityConfig/{id}
Identity/Identity Settings
Manage tenant-specific identity settings. This REST API is SCIM compliant.
There is a single pre-seeded instance of IdentitySettings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
There is a single pre-seeded instance of IdentitySettings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
- Get Identity Settings
- Method: getPath:
/admin/v1/IdentitySettings/{id}
- HTTP Options
- Method:Path:
/admin/v1/IdentitySettings
- Replace Identity Settings
- Method: putPath:
/admin/v1/IdentitySettings/{id}
- Search Identity Settings
- Method: getPath:
/admin/v1/IdentitySettings
- Search Identity Settings Using POST
- Method: postPath:
/admin/v1/IdentitySettings/.search
- Update Identity Settings
- Method: patchPath:
/admin/v1/IdentitySettings/{id}
Identity/Kerberos Realm Users
Use this endpoint to manage Kerberos Realm users, including creating a Kerberos Realm user, deleting, searching for users, replacing, and patching Kerberos Realm user information. This REST API is SCIM compliant.
- Get a Kerberos Realm User
- Method: getPath:
/admin/v1/KerberosRealmUsers/{id}
- HTTP Options
- Method:Path:
/admin/v1/KerberosRealmUsers
- Search Kerberos Realm Users
- Method: getPath:
/admin/v1/KerberosRealmUsers
- Search Kerberos Realm Users Using POST
- Method: postPath:
/admin/v1/KerberosRealmUsers/.search
- Update a Kerberos Realm User
- Method: patchPath:
/admin/v1/KerberosRealmUsers/{id}
Identity/My Api Keys
Manage logged in user's api key. This REST API is SCIM compliant.
Added In Release: 2009232244
Added In Release: 2009232244
- Add a user's api key
- Method: postPath:
/admin/v1/MyApiKeys
- Delete user's api key
- Method: deletePath:
/admin/v1/MyApiKeys/{id}
- Get user's api key
- Method: getPath:
/admin/v1/MyApiKeys/{id}
- HTTP Options
- Method:Path:
/admin/v1/MyApiKeys
- Search Api Key
- Method: getPath:
/admin/v1/MyApiKeys
- Update user's api key
- Method: patchPath:
/admin/v1/MyApiKeys/{id}
Identity/My Auth Tokens
Manage logged-in user's auth token. This REST API is SCIM compliant.
Added In Release: 2009232244
Added In Release: 2009232244
- Add user's auth token
- Method: postPath:
/admin/v1/MyAuthTokens
- Delete user's auth token
- Method: deletePath:
/admin/v1/MyAuthTokens/{id}
- Get user's auth token
- Method: getPath:
/admin/v1/MyAuthTokens/{id}
- HTTP Options
- Method:Path:
/admin/v1/MyAuthTokens
- Search AuthTokens
- Method: getPath:
/admin/v1/MyAuthTokens
- Update user's AuthToken
- Method: patchPath:
/admin/v1/MyAuthTokens/{id}
Identity/My Customer Secret Keys
Manage logged in user's customer secret key. This REST API is SCIM compliant.
Added In Release: 2009232244
Added In Release: 2009232244
- Add a user's customer secret key
- Method: postPath:
/admin/v1/MyCustomerSecretKeys
- Delete user's customer secret key
- Method: deletePath:
/admin/v1/MyCustomerSecretKeys/{id}
- Get user's customer secret key
- Method: getPath:
/admin/v1/MyCustomerSecretKeys/{id}
- HTTP Options
- Method:Path:
/admin/v1/MyCustomerSecretKeys
- Search user's customer secret key
- Method: getPath:
/admin/v1/MyCustomerSecretKeys
- Update user's customer secret key
- Method: patchPath:
/admin/v1/MyCustomerSecretKeys/{id}
Identity/My OAuth2 Client Credentials
Manage logged-in user's oauth2 client credential. This REST API is SCIM compliant.
- Add a user's oauth2 client credential
- Method: postPath:
/admin/v1/MyOAuth2ClientCredentials
- Delete user's oauth2 client credential
- Method: deletePath:
/admin/v1/MyOAuth2ClientCredentials/{id}
- Get user's oauth2 client credential
- Method: getPath:
/admin/v1/MyOAuth2ClientCredentials/{id}
- HTTP Options
- Method:Path:
/admin/v1/MyOAuth2ClientCredentials
- Search oauth2 client credentials
- Method: getPath:
/admin/v1/MyOAuth2ClientCredentials
- Update user's oauth2 client credential
- Method: patchPath:
/admin/v1/MyOAuth2ClientCredentials/{id}
Identity/My Smtp Credentials
Manage logged-in user's smtp credentials. This REST API is SCIM compliant.
Added In Release: 2009232244
Added In Release: 2009232244
- Add a user's smtp credenials
- Method: postPath:
/admin/v1/MySmtpCredentials
- Delete user's smtp credenials
- Method: deletePath:
/admin/v1/MySmtpCredentials/{id}
- Get user's smtp credentials
- Method: getPath:
/admin/v1/MySmtpCredentials/{id}
- HTTP Options
- Method:Path:
/admin/v1/MySmtpCredentials
- Search smtp credentials
- Method: getPath:
/admin/v1/MySmtpCredentials
- Update user's smtp credentials
- Method: patchPath:
/admin/v1/MySmtpCredentials/{id}
Identity/My User DB Credentials
Use this endpoint to manage a logged in user's DbCredentials.
- Get a User's DbCredentials
- Method: getPath:
/admin/v1/MyUserDbCredentials/{id}
- HTTP Options
- Method:Path:
/admin/v1/MyUserDbCredentials
- Remove a User's DbCredential
- Method: deletePath:
/admin/v1/MyUserDbCredentials/{id}
- Search a User's DBCredentials
- Method: getPath:
/admin/v1/MyUserDbCredentials
- Set a User's DbCredential
- Method: postPath:
/admin/v1/MyUserDbCredentials
Identity/MySupportAccount
Manages logged in user's Support Accounts. This REST API is SCIM compliant.
- Create a Support Account
- Method: postPath:
/admin/v1/MySupportAccounts
- Delete a Support Account
- Method: deletePath:
/admin/v1/MySupportAccounts/{id}
- Get a Support Account
- Method: getPath:
/admin/v1/MySupportAccounts/{id}
- HTTP Options
- Method:Path:
/admin/v1/MySupportAccounts
- Search Support Accounts
- Method: getPath:
/admin/v1/MySupportAccounts
Identity/OAuth2 Client Credentials
Manage user's oauth2 client credential. This REST API is SCIM compliant.
- Add a user's oauth2 client credential
- Method: postPath:
/admin/v1/OAuth2ClientCredentials
- Delete user's oauth2 client credential
- Method: deletePath:
/admin/v1/OAuth2ClientCredentials/{id}
- Get user's oauth2 client credential
- Method: getPath:
/admin/v1/OAuth2ClientCredentials/{id}
- HTTP Options
- Method:Path:
/admin/v1/OAuth2ClientCredentials
- Search oauth2 client credentials
- Method: getPath:
/admin/v1/OAuth2ClientCredentials
- Search Oauth2Clients Using POST
- Method: postPath:
/admin/v1/OAuth2ClientCredentials/.search
- Update user's oauth2 client credential
- Method: patchPath:
/admin/v1/OAuth2ClientCredentials/{id}
Identity/Password Authenticator
Use to authenticate a user or an app with the user or app's unique attribute/value pair and password. This REST API is SCIM-compliant.
- Check Password of Specified User or App
- Method: postPath:
/admin/v1/PasswordAuthenticator
- HTTP Options
- Method:Path:
/admin/v1/PasswordAuthenticator
Identity/Password Policies
Manage all password policy administrative tasks. This REST API is SCIM compliant.
- Create a Password Policy
- Method: postPath:
/admin/v1/PasswordPolicies
- Delete a Password Policy
- Method: deletePath:
/admin/v1/PasswordPolicies/{id}
- Get a Password Policy
- Method: getPath:
/admin/v1/PasswordPolicies/{id}
- HTTP Options
- Method:Path:
/admin/v1/PasswordPolicies
- Replace a Password Policy
- Method: putPath:
/admin/v1/PasswordPolicies/{id}
- Search Password Policies
- Method: getPath:
/admin/v1/PasswordPolicies
- Search Password Policies Using POST
- Method: postPath:
/admin/v1/PasswordPolicies/.search
- Update a Password Policy
- Method: patchPath:
/admin/v1/PasswordPolicies/{id}
Identity/Resource Exporter
Use this endpoint to export resources synchronously in JSON format. Currently 40 maximum resources are allowed to export synchronously.
- HTTP Options
- Method:Path:
/admin/v1/ResourceExporter
- Request to Export Resources
- Method: postPath:
/admin/v1/ResourceExporter
Identity/Resource Importer
Use the Resource Importer endpoint to import different resources from a JSON file uploaded to cloud storage.
- HTTP Options
- Method:Path:
/admin/v1/ResourceImporter
- Import Different Resources
- Method: postPath:
/admin/v1/ResourceImporter
Identity/Security Question Settings
Use this endpoint to manage tenant-specific security question settings.
- Get Security Question Settings
- Method: getPath:
/admin/v1/SecurityQuestionSettings/{id}
- HTTP Options
- Method:Path:
/admin/v1/SecurityQuestionSettings
- Replace Security Question Settings
- Method: putPath:
/admin/v1/SecurityQuestionSettings/{id}
- Search Security Question Settings
- Method: getPath:
/admin/v1/SecurityQuestionSettings
- Search Security Question Settings Using POST
- Method: postPath:
/admin/v1/SecurityQuestionSettings/.search
- Update Security Question Settings
- Method: patchPath:
/admin/v1/SecurityQuestionSettings/{id}
Identity/Security Questions
Use this endpoint to maintain the available set of security questions for the end user. The Security Admin can update this set with custom questions, but can't remove or change the set of pre-seeded questions.
- Create a Security Question
- Method: postPath:
/admin/v1/SecurityQuestions
- Delete a Security Question
- Method: deletePath:
/admin/v1/SecurityQuestions/{id}
- Get a Security Question
- Method: getPath:
/admin/v1/SecurityQuestions/{id}
- HTTP Options
- Method:Path:
/admin/v1/SecurityQuestions
- Search Security Questions
- Method: getPath:
/admin/v1/SecurityQuestions
- Search Security Questions Using POST
- Method: postPath:
/admin/v1/SecurityQuestions/.search
- Update a Security Question
- Method: patchPath:
/admin/v1/SecurityQuestions/{id}
Identity/Self Registration Profiles
Use this endpoint to manage self-registration profiles. This REST API is SCIM compliant.
- Create a Self-Registration Profile
- Method: postPath:
/admin/v1/SelfRegistrationProfiles
- Delete a Self-Registration Profile
- Method: deletePath:
/admin/v1/SelfRegistrationProfiles/{id}
- Get a Self-Registration Profile
- Method: getPath:
/admin/v1/SelfRegistrationProfiles/{id}
- HTTP Options
- Method:Path:
/admin/v1/SelfRegistrationProfiles
- Replace a Self-Registration Profile
- Method: putPath:
/admin/v1/SelfRegistrationProfiles/{id}
- Search Self-Registration Profiles
- Method: getPath:
/admin/v1/SelfRegistrationProfiles
- Search Self-Registration Profiles Using POST
- Method: postPath:
/admin/v1/SelfRegistrationProfiles/.search
- Update a Self-Registration Profile
- Method: patchPath:
/admin/v1/SelfRegistrationProfiles/{id}
Identity/Smtp Credentials
Manage user's smtp credentials. This REST API is SCIM compliant.
Added In Release: 2009232244
Added In Release: 2009232244
- Add a user's smtp credenials
- Method: postPath:
/admin/v1/SmtpCredentials
- Delete user's smtp credenials
- Method: deletePath:
/admin/v1/SmtpCredentials/{id}
- Get user's smtp credentials
- Method: getPath:
/admin/v1/SmtpCredentials/{id}
- HTTP Options
- Method:Path:
/admin/v1/SmtpCredentials
- Search smtp credentials
- Method: getPath:
/admin/v1/SmtpCredentials
- Search smtp credentials Using POST
- Method: postPath:
/admin/v1/SmtpCredentials/.search
- Update user's smtp credentials
- Method: patchPath:
/admin/v1/SmtpCredentials/{id}
Identity/SupportAccount
Manages user's Support Accounts. This REST API is SCIM compliant.
- Create a Support Account
- Method: postPath:
/admin/v1/SupportAccounts
- Delete a Support Account
- Method: deletePath:
/admin/v1/SupportAccounts/{id}
- Get a Support Account
- Method: getPath:
/admin/v1/SupportAccounts/{id}
- HTTP Options
- Method:Path:
/admin/v1/SupportAccounts
- Search Support Accounts
- Method: getPath:
/admin/v1/SupportAccounts
Identity/User Activation Initiator
Use to initiate user activation by sending an activation email to a user who has not yet been activated in the system. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/UserActivationInitiator
- Initiate User Activation
- Method: putPath:
/admin/v1/UserActivationInitiator/{id}
Identity/User Apps Enabled For Authentication
Use this endpoint to return a list of all available target apps for a user on which authentication can be performed.
Added In Release: 18.2.6
Added In Release: 18.2.6
- Get Target Apps for a User
- Method: getPath:
/admin/v1/UserAppsEnabledForAuthentication/{id}
- HTTP Options
- Method:Path:
/admin/v1/UserAppsEnabledForAuthentication
Identity/User Apps Enabled For Delegated Authentication
Use this endpoint to return a list of all available target apps for a user on which delegated authentication can be performed.
Added In Release: 17.4.6
Added In Release: 17.4.6
- Get Target Apps for a User
- Method: getPath:
/admin/v1/UserAppsEnabledForDelegatedAuthentication/{id}
- HTTP Options
- Method:Path:
/admin/v1/UserAppsEnabledForDelegatedAuthentication
Identity/User Attributes Validator
Validates the user attributes. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/UserAttributesValidator
- Validate Users Attributes
- Method: postPath:
/admin/v1/UserAttributesValidator
Identity/User Capabilities Changer
Change a user's capabilities. This REST API is SCIM compliant.
Added In Release: 2009232244
Added In Release: 2009232244
- Change user capabilities
- Method: putPath:
/admin/v1/UserCapabilitiesChanger/{id}
- HTTP Options
- Method:Path:
/admin/v1/UserCapabilitiesChanger
Identity/User DB Credentials
Use this endpoint to manage a user's DbCredentials.
- Get a User's DbCredentials
- Method: getPath:
/admin/v1/UserDbCredentials/{id}
- HTTP Options
- Method:Path:
/admin/v1/UserDbCredentials
- Remove a User's DbCredential
- Method: deletePath:
/admin/v1/UserDbCredentials/{id}
- Search a User's DBCredentials
- Method: getPath:
/admin/v1/UserDbCredentials
- Search a User's DBCredentials using POST
- Method: postPath:
/admin/v1/UserDbCredentials/.search
- Set a User's DbCredential
- Method: postPath:
/admin/v1/UserDbCredentials
Identity/User DB login status update
Use this endpoint update DB user's login status
- HTTP Options
- Method:Path:
/admin/v1/UserDbLoginStatusUpdater
- Set a User's DbCredential
- Method: postPath:
/admin/v1/UserDbLoginStatusUpdater
Identity/User Locked State Changer
Use this endpoint to update the user state and the password state of the user.
- HTTP Options
- Method:Path:
/admin/v1/UserLockedStateChanger
- Unlock a User
- Method: postPath:
/admin/v1/UserLockedStateChanger
Identity/User Name Generator
Use this endpoint to generate a unique user name. This REST API is SCIM compliant.
- Generate a User Name
- Method: postPath:
/admin/v1/UserNameGenerator
- HTTP Options
- Method:Path:
/admin/v1/UserNameGenerator
Identity/User Password Changer
Change a user's password to a known value. This REST API is SCIM compliant.
- Change a User Password (Known Value)
- Method: putPath:
/admin/v1/UserPasswordChanger/{id}
- HTTP Options
- Method:Path:
/admin/v1/UserPasswordChanger
Identity/User Password Generator
Obtain a randomly generated password based on the configured password policy. This REST API is SCIM compliant.
- Generate a Password
- Method: putPath:
/admin/v1/UserPasswordGenerator/{id}
- Generate a User Password
- Method: postPath:
/admin/v1/UserPasswordGenerator
- HTTP Options
- Method:Path:
/admin/v1/UserPasswordGenerator
Identity/User Password Resetter
Reset a user's password to a randomly generated value that is based on the configured password policy. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/UserPasswordResetter
- Reset a User Password (Random Value)
- Method: putPath:
/admin/v1/UserPasswordResetter/{id}
Identity/User Password Validator
Validate a password based on the configured password policy. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/UserPasswordValidator
- Validate a Password
- Method: putPath:
/admin/v1/UserPasswordValidator/{id}
- Validate a User Password
- Method: postPath:
/admin/v1/UserPasswordValidator
Identity/User Status Changer
Change a user's status by setting the active attribute to true or false. This REST API is SCIM compliant.
- Change User Status
- Method: putPath:
/admin/v1/UserStatusChanger/{id}
- HTTP Options
- Method:Path:
/admin/v1/UserStatusChanger
Identity/User Token Validator
Validates that a user token was received from the client. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/UserTokenValidator
- Validate a User Token
- Method: postPath:
/admin/v1/UserTokenValidator
Identity/User Tokens
Manage tasks for short-lived user tokens used to verify that sensitive operations, which do not require regular authentication, are being carried out by the correct user--for example, operations such as forgot password, admin resets a user's password, and password recovery verification. This REST API is SCIM compliant.
- Get a User Token
- Method: getPath:
/admin/v1/UserTokens/{id}
- HTTP Options
- Method:Path:
/admin/v1/UserTokens
- Search User Tokens
- Method: getPath:
/admin/v1/UserTokens
- Search User Tokens Using POST
- Method: postPath:
/admin/v1/UserTokens/.search
Identity/Users
Manage users. You can create user accounts only if you are granted access to the Identity Domain Administrator or User Administrator role. By default, Oracle Identity Cloud Service contains one user account (admin@oracle.com) for the Identity Domain Administrator. This REST API is SCIM compliant.
- Create a User
- Method: postPath:
/admin/v1/Users
- Delete a User
- Method: deletePath:
/admin/v1/Users/{id}
- Get a User
- Method: getPath:
/admin/v1/Users/{id}
- HTTP Options
- Method:Path:
/admin/v1/Users
- Replace a User
- Method: putPath:
/admin/v1/Users/{id}
- Search Users
- Method: getPath:
/admin/v1/Users
- Search Users Using POST
- Method: postPath:
/admin/v1/Users/.search
- Update a User
- Method: patchPath:
/admin/v1/Users/{id}
Jobs/Job Histories
Retrieve a job history by ID or retrieve all existing job histories. A job history is created after a job begins and contains information such as start-time, job type, ID, status, and so on. After the job completes, the history is updated with the job end time, status, and failure reason, if any. This REST API is SCIM compliant.
- Get Job Status Info
- Method: getPath:
/job/v1/JobHistories/{id}
- HTTP Options
- Method:Path:
/job/v1/JobHistories
- Search Job Status Info
- Method: getPath:
/job/v1/JobHistories
- Search Job Status Info Using POST
- Method: postPath:
/job/v1/JobHistories/.search
Jobs/Job Progress
Retrieve job progress by ID or cancel a job. Job progress is purged automatically after a job completes. This REST API is SCIM compliant.
- Delete Job Progress Info
- Method: deletePath:
/job/v1/JobProgress/{id}
- Get Job Progress Info
- Method: getPath:
/job/v1/JobProgress/{id}
- HTTP Options
- Method:Path:
/job/v1/JobProgress
Jobs/Job Reports
Retrieve job reports by ID or all existing job reports. This REST API is SCIM compliant.
- Get a Job Report
- Method: getPath:
/job/v1/JobReports/{id}
- HTTP Options
- Method:Path:
/job/v1/JobReports
- Search Job Reports
- Method: getPath:
/job/v1/JobReports
- Search Job Reports Using POST
- Method: postPath:
/job/v1/JobReports/.search
Jobs/Job Schedules
Manage all job scheduling administrative tasks including scheduling a job to run and deleting job schedules. You can also search for job schedules by ID or retrieve all future schedules. This REST API is SCIM compliant.
- Delete a Job Schedule
- Method: deletePath:
/job/v1/JobSchedules/{id}
- Get a Job Schedule
- Method: getPath:
/job/v1/JobSchedules/{id}
- HTTP Options
- Method:Path:
/job/v1/JobSchedules
- Schedule a Job
- Method: postPath:
/job/v1/JobSchedules
- Search Job Schedules
- Method: getPath:
/job/v1/JobSchedules
- Search Job Schedules Using POST
- Method: postPath:
/job/v1/JobSchedules/.search
- Update a JobSchedule
- Method: patchPath:
/job/v1/JobSchedules/{id}
Jobs/Jobs
Retrieve a list of jobs in the system. This REST API is SCIM compliant.
- Get a Job
- Method: getPath:
/job/v1/Jobs/{id}
- HTTP Options
- Method:Path:
/job/v1/Jobs
- Search Jobs
- Method: getPath:
/job/v1/Jobs
- Search Jobs Using POST
- Method: postPath:
/job/v1/Jobs/.search
Multi-Factor Authentication (MFA)/Authentication Factors Remover
This endpoint is used by a user to delete all of the Multi-Factor Authentication channels that the user is enrolled in. This includes the user's registered devices, bypass codes created for the user, any trusted devices for the user, and any security questions registered for the user. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/AuthenticationFactorsRemover
- Remove All Authentication Factor Channels for a User
- Method: postPath:
/admin/v1/AuthenticationFactorsRemover
Multi-Factor Authentication (MFA)/Bypass Codes
Use this endpoint to manage Multi-Factor Authentication Bypass Codes for each tenant. This REST API is SCIM compliant.
- Create a Bypass Code
- Method: postPath:
/admin/v1/BypassCodes
- Delete a Bypass Code
- Method: deletePath:
/admin/v1/BypassCodes/{id}
- Get a Bypass Code
- Method: getPath:
/admin/v1/BypassCodes/{id}
- HTTP Options
- Method:Path:
/admin/v1/BypassCodes
- Search Bypass Codes
- Method: getPath:
/admin/v1/BypassCodes
- Search Bypass Codes Using POST
- Method: postPath:
/admin/v1/BypassCodes/.search
Multi-Factor Authentication (MFA)/Devices
Use this endpoint to manage devices enrolled in Multi-Factor Authentication. This REST API is SCIM compliant.
- Get a Device
- Method: getPath:
/admin/v1/Devices/{id}
- HTTP Options
- Method:Path:
/admin/v1/Devices
- Search Devices
- Method: getPath:
/admin/v1/Devices
- Search Devices Using POST
- Method: postPath:
/admin/v1/Devices/.search
Multi-Factor Authentication (MFA)/Settings
Use this endpoint to manage Multi-Factor Authentication settings for tenants. This REST API is SCIM compliant.
There is a single pre-seeded instance of AuthenticationFactorSettings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
There is a single pre-seeded instance of AuthenticationFactorSettings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
- Get Authentication Factor Settings
- Method: getPath:
/admin/v1/AuthenticationFactorSettings/{id}
- HTTP Options
- Method:Path:
/admin/v1/AuthenticationFactorSettings
- Replace Authentication Factor Settings
- Method: putPath:
/admin/v1/AuthenticationFactorSettings/{id}
- Search Authentication Factor Settings
- Method: getPath:
/admin/v1/AuthenticationFactorSettings
- Search Authentication Factor Settings Using POST
- Method: postPath:
/admin/v1/AuthenticationFactorSettings/.search
My Access/My Groups
A user can use this endpoint to view and search for Groups that are granted to the user. This endpoint supports filtering by Group attributes. This REST API is SCIM compliant.
Added In Release: 17.3.4
Added In Release: 17.3.4
- HTTP Options
- Method:Path:
/admin/v1/MyGroups
- Search My Groups
- Method: getPath:
/admin/v1/MyGroups
- Search My Groups Using POST
- Method: postPath:
/admin/v1/MyGroups/.search
My Access/My Requestable Apps
A user can use this endpoint to view and search for Requestables that are granted to the user. This endpoint supports filtering by Requestable attributes. This REST API is SCIM compliant.
Added In Release: 17.3.4
Added In Release: 17.3.4
- HTTP Options
- Method:Path:
/admin/v1/MyRequestableApps
- Search My Requestable Apps
- Method: getPath:
/admin/v1/MyRequestableApps
- Search My Requestable Apps Using POST
- Method: postPath:
/admin/v1/MyRequestableApps/.search
My Access/My Requestable Groups
A user can use this endpoint to view and search for Requestables that are granted to the user. This endpoint supports filtering by Requestable attributes. This REST API is SCIM compliant.
Added In Release: 17.3.4
Added In Release: 17.3.4
- HTTP Options
- Method:Path:
/admin/v1/MyRequestableGroups
- Search My Requestable Groups
- Method: getPath:
/admin/v1/MyRequestableGroups
- Search My Requestable Groups Using POST
- Method: postPath:
/admin/v1/MyRequestableGroups/.search
My Access/My Requests
A user can use this endpoint to view and search for their submitted Requests. This endpoint supports filtering by Request attributes. This REST API is SCIM compliant.
Added In Release: 17.3.4
Added In Release: 17.3.4
- Create a Request
- Method: postPath:
/admin/v1/MyRequests
- HTTP Options
- Method:Path:
/admin/v1/MyRequests
- Search My Requests
- Method: getPath:
/admin/v1/MyRequests
- Search My Requests Using POST
- Method: postPath:
/admin/v1/MyRequests/.search
Notification/Email Templates
Manage email templates used for notification. An email template includes the localized body and the localized subject for an email to be sent as a result of a particular event. Replace, update, and retrieve an email template by uniqueId or use search/GET to retrieve one or more templates. Creating and deleting an email template is used only for self-registration use cases. You can't delete the email templates that come standard with Oracle Identity Cloud Service. This REST API is SCIM compliant.
- Create an Email Template
- Method: postPath:
/admin/v1/EmailTemplates
- Delete an Email Template
- Method: deletePath:
/admin/v1/EmailTemplates/{id}
- Get an Email Template
- Method: getPath:
/admin/v1/EmailTemplates/{id}
- HTTP Options
- Method:Path:
/admin/v1/EmailTemplates
- Replace an Email Template
- Method: putPath:
/admin/v1/EmailTemplates/{id}
- Search Email Templates
- Method: getPath:
/admin/v1/EmailTemplates
- Search Email Templates Using POST
- Method: postPath:
/admin/v1/EmailTemplates/.search
- Update an Email Template
- Method: patchPath:
/admin/v1/EmailTemplates/{id}
Notification/External Notification Provider
Use this endpoint to manage external notification provider to send notification. This REST API is SCIM compliant.
Added In Release: 20.1.3
Added In Release: 20.1.3
- Create the External Notification Provider
- Method: postPath:
/admin/v1/ExternalNotificationProviders
- Delete the External Notification Provider
- Method: deletePath:
/admin/v1/ExternalNotificationProviders/{id}
- Get the External Notification Provider details
- Method: getPath:
/admin/v1/ExternalNotificationProviders/{id}
- HTTP Options
- Method:Path:
/admin/v1/ExternalNotificationProviders
- Replace the External Notification Provider
- Method: putPath:
/admin/v1/ExternalNotificationProviders/{id}
- Search External Notification Provider
- Method: getPath:
/admin/v1/ExternalNotificationProviders
- Search External Notification Provider Using POST
- Method: postPath:
/admin/v1/ExternalNotificationProviders/.search
Notification/From Email Address Validator
Use this endpoint to validate the status of the From Email Address or Email Domain from the OPC Notification Service.
Added In Release: 18.4.2
Added In Release: 18.4.2
- HTTP Options
- Method:Path:
/admin/v1/FromEmailAddressValidator
- Validate From Email or Domain Validation Request
- Method: postPath:
/admin/v1/FromEmailAddressValidator
Notification/Notification Settings
Manage notification settings. Notification settings enable you to configure the events that are sent and who they are sent from. This REST API is SCIM compliant.
There is a single pre-seeded instance of NotificationSettings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
There is a single pre-seeded instance of NotificationSettings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
- Get Notification Settings
- Method: getPath:
/admin/v1/NotificationSettings/{id}
- HTTP Options
- Method:Path:
/admin/v1/NotificationSettings
- Replace Notification Settings
- Method: putPath:
/admin/v1/NotificationSettings/{id}
- Search Notification Settings
- Method: getPath:
/admin/v1/NotificationSettings
- Search Notification Settings Using POST
- Method: postPath:
/admin/v1/NotificationSettings/.search
Notification/Phone call Templates
Use this endpoint to manage the phone call templates that are used for notifications. This REST API is SCIM compliant.
Added In Release: 20.2.2
Added In Release: 20.2.2
- Create a phone call Template
- Method: postPath:
/admin/v1/PhoneCallTemplates
- Get a phone call Template
- Method: getPath:
/admin/v1/PhoneCallTemplates/{id}
- HTTP Options
- Method:Path:
/admin/v1/PhoneCallTemplates
- Replace a phone call Template
- Method: putPath:
/admin/v1/PhoneCallTemplates/{id}
- Search phone call Templates
- Method: getPath:
/admin/v1/PhoneCallTemplates
- Search phone call Templates Using POST
- Method: postPath:
/admin/v1/PhoneCallTemplates/.search
- Update a phone call Template
- Method: patchPath:
/admin/v1/PhoneCallTemplates/{id}
Notification/SMS Templates
Use this endpoint to manage the SMS templates that are used for notifications. This REST API is SCIM compliant.
- Get an SMS Template
- Method: getPath:
/admin/v1/SMSTemplates/{id}
- HTTP Options
- Method:Path:
/admin/v1/SMSTemplates
- Replace an SMS Template
- Method: putPath:
/admin/v1/SMSTemplates/{id}
- Search SMS Templates
- Method: getPath:
/admin/v1/SMSTemplates
- Search SMS Templates Using POST
- Method: postPath:
/admin/v1/SMSTemplates/.search
- Update an SMS Template
- Method: patchPath:
/admin/v1/SMSTemplates/{id}
OAuth Runtime/Authorize Flow (Browser Flow)
Use this endpoint to obtain an authorization code by submitting a GET request through the browser. You then use the authorization code to obtain an access token using the oauth2/v1/token endpoint. This is called the 3-legged OAuth flow.
- Generate Authorization Code and Identity Token (3-legged OAuth Flow)
- Method: getPath:
/oauth2/v1/authorize
- HTTP Options
- Method:Path:
/oauth2/v1/authorize
OAuth Runtime/Device Code Grant Type (OAuth Device Flow)
Obtain an Access Token using the Device Code that you obtained during the OAuth Device Flow.
- Generate Device Code and User Code (OAuth Device Flow)
- Method: postPath:
/oauth2/v1/device
- HTTP Options
- Method:Path:
/oauth2/v1/device
OAuth Runtime/Introspect Token
Use this endpoint to obtain information about the circumstances under which a token was created. Data returned includes the expiry date of the token, the intended audience, any assurance level that was associated, and so on. Think of this endpoint as delivering context about the user's current session.
- HTTP Options
- Method:Path:
/oauth2/v1/introspect
- Validate the Token
- Method: postPath:
/oauth2/v1/introspect
OAuth Runtime/Logout
Logs a user out and removes associated cookies and sessions.
- HTTP Options
- Method:Path:
/oauth2/v1/userlogout
- Log Out
- Method: getPath:
/oauth2/v1/userlogout
OAuth Runtime/OAuth Runtime Tokens
Obtain an Access Token and other OAuth Runtime tokens using one of the grant type flows. An Access Token can be obtained in several ways:
- Client Credential grant flow (either client_ID/client_secret or client assertion)
- Password grant flow
- SAML2 Assertion grant flow
- JWT Assertion grant flow
- 3-legged grant flow (Authorization Code/Implicit)
- Device Code grant flow
- Refresh Token to regenerate an Access Token
- Generate Access Token and Other OAuth Runtime Tokens to Access the Resource
- Method: postPath:
/oauth2/v1/token
- HTTP Options
- Method:Path:
/oauth2/v1/token
OAuth Runtime/Revoke Refresh Token
Revoke a Refresh Token.
- HTTP Options
- Method:Path:
/oauth2/v1/revoke
- Revoke Refresh Token
- Method: postPath:
/oauth2/v1/revoke
OAuth Runtime/User Info
Obtain user information based on the Access Token.
- Generate User Details Using Access Token
- Method: getPath:
/oauth2/v1/userinfo
- HTTP Options
- Method:Path:
/oauth2/v1/userinfo
OAuth2/OAuth Consent
Manage OAuth user consent to client applications for certain OAuth scopes. This REST API is SCIM compliant.
- Delete an OAuth Consent
- Method: deletePath:
/admin/v1/OAuthConsents/{id}
- Get an OAuth Consent
- Method: getPath:
/admin/v1/OAuthConsents/{id}
- HTTP Options
- Method:Path:
/admin/v1/OAuthConsents
- Search OAuth Consents
- Method: getPath:
/admin/v1/OAuthConsents
- Search OAuth Consents Using POST
- Method: postPath:
/admin/v1/OAuthConsents/.search
On-Demand MFA/Factor Enrollment
Use this endpoint to initiate and complete MFA factor enrollment for a user, to fetch the list of enrolled MFA factors, and to perform factor management operations.
- Change Default MFA Factor or Un-Enroll in MFA
- Method: patchPath:
/mfa/v1/users/{userGUID}
- Complete Factor Enrollment or Resend OTP or Update Security Questions
- Method: patchPath:
/mfa/v1/users/{userGUID}/factors/{factorId}
- Delete an Enrolled MFA Factor
- Method: deletePath:
/mfa/v1/users/{userGUID}/factors/{factorId}
- Get Enrolled MFA Factors Using a Filter
- Method: getPath:
/mfa/v1/users
- Get Enrolled MFA Factors Using the User GUID
- Method: getPath:
/mfa/v1/users/{userGUID}/factors
- Get Factor Enrollment Status
- Method: getPath:
/mfa/v1/users/{userGUID}/factors/{factorId}
- HTTP Options
- Method:Path:
/mfa/v1/users
- Initiate MFA Factor Enrollment With Verification or MFA Factor Enrollment Without Verification
- Method: postPath:
/mfa/v1/users/{userGUID}/factors
On-Demand MFA/Factor Verification
Use this endpoint to initiate and complete verification of a default factor or a backup factor.
- Complete Factor Verification
- Method: patchPath:
/mfa/v1/requests/{requestId}
- Get Mobile App Notification Verification Status
- Method: getPath:
/mfa/v1/requests/{requestId}
- HTTP Options
- Method:Path:
/mfa/v1/requests
- Initiate Factor Verification
- Method: postPath:
/mfa/v1/requests
Policy/Condition Group Templates
Use this endpoint to manage templates for a group of conditions to be evaluated. Condition Group Templates are referenced from a Rule Template. This REST API is SCIM compliant.
- Create a Condition Group Template
- Method: postPath:
/admin/v1/ConditionGroupTemplates
- Delete a Condition Group Template
- Method: deletePath:
/admin/v1/ConditionGroupTemplates/{id}
- Get a Condition Group Template
- Method: getPath:
/admin/v1/ConditionGroupTemplates/{id}
- HTTP Options
- Method:Path:
/admin/v1/ConditionGroupTemplates
- Replace a Condition Group Template
- Method: putPath:
/admin/v1/ConditionGroupTemplates/{id}
- Search Condition Group Templates
- Method: getPath:
/admin/v1/ConditionGroupTemplates
- Search Condition Group Templates Using POST
- Method: postPath:
/admin/v1/ConditionGroupTemplates/.search
- Update a Condition Group Template
- Method: patchPath:
/admin/v1/ConditionGroupTemplates/{id}
Policy/Condition Groups
Use this endpoint to manage a group of conditions to be evaluated. Condition groups are referenced from a Rule. This REST API is SCIM compliant.
- Create a Condition Group
- Method: postPath:
/admin/v1/ConditionGroups
- Delete a Condition Group
- Method: deletePath:
/admin/v1/ConditionGroups/{id}
- Get a Condition Group
- Method: getPath:
/admin/v1/ConditionGroups/{id}
- HTTP Options
- Method:Path:
/admin/v1/ConditionGroups
- Replace a Condition Group
- Method: putPath:
/admin/v1/ConditionGroups/{id}
- Search Condition Groups
- Method: getPath:
/admin/v1/ConditionGroups
- Search Condition Groups Using POST
- Method: postPath:
/admin/v1/ConditionGroups/.search
- Update a Condition Group
- Method: patchPath:
/admin/v1/ConditionGroups/{id}
Policy/Condition Templates
Use this endpoint to manage condition templates. Condition Templates are referenced from a Condition Template Group. This REST API is SCIM compliant.
- Create a Condition Template
- Method: postPath:
/admin/v1/ConditionTemplates
- Delete a Condition Template
- Method: deletePath:
/admin/v1/ConditionTemplates/{id}
- Get a Condition Template
- Method: getPath:
/admin/v1/ConditionTemplates/{id}
- HTTP Options
- Method:Path:
/admin/v1/ConditionTemplates
- Replace a Condition Template
- Method: putPath:
/admin/v1/ConditionTemplates/{id}
- Search Condition Templates
- Method: getPath:
/admin/v1/ConditionTemplates
- Search Condition Templates Using POST
- Method: postPath:
/admin/v1/ConditionTemplates/.search
- Update a Condition Template
- Method: patchPath:
/admin/v1/ConditionTemplates/{id}
Policy/Conditions
Use this endpoint to manage conditions to be evaluated. Conditions are referenced from Condition Groups. This REST API is SCIM compliant.
- Create a Condition
- Method: postPath:
/admin/v1/Conditions
- Delete a Condition
- Method: deletePath:
/admin/v1/Conditions/{id}
- Get a Condition
- Method: getPath:
/admin/v1/Conditions/{id}
- HTTP Options
- Method:Path:
/admin/v1/Conditions
- Replace a Condition
- Method: putPath:
/admin/v1/Conditions/{id}
- Search Conditions
- Method: getPath:
/admin/v1/Conditions
- Search Conditions Using POST
- Method: postPath:
/admin/v1/Conditions/.search
- Update a Condition
- Method: patchPath:
/admin/v1/Conditions/{id}
Policy/NetworkPerimeters
Use this endpoint to manage NetworkPerimeter conditions to be evaluated.NetworkPerimeter Conditions are referenced from Condition or Condition Groups. This REST API is SCIM compliant.
Added In Release: 18.1.2
Added In Release: 18.1.2
- Create a NetworkPerimeter
- Method: postPath:
/admin/v1/NetworkPerimeters
- Delete a NetworkPerimeter
- Method: deletePath:
/admin/v1/NetworkPerimeters/{id}
- Get a NetworkPerimeter
- Method: getPath:
/admin/v1/NetworkPerimeters/{id}
- HTTP Options
- Method:Path:
/admin/v1/NetworkPerimeters
- Replace a NetworkPerimeter
- Method: putPath:
/admin/v1/NetworkPerimeters/{id}
- Search NetworkPerimeters
- Method: getPath:
/admin/v1/NetworkPerimeters
- Search NetworkPerimeters Using POST
- Method: postPath:
/admin/v1/NetworkPerimeters/.search
- Update a NetworkPerimeter
- Method: patchPath:
/admin/v1/NetworkPerimeters/{id}
Policy/Policies
Use this endpoint to manage policies, which are a named and ordered list of rules that are evaluated as part of run-time requests. This REST API is SCIM compliant.
- Create a Policy
- Method: postPath:
/admin/v1/Policies
- Delete a Policy
- Method: deletePath:
/admin/v1/Policies/{id}
- Get a Policy
- Method: getPath:
/admin/v1/Policies/{id}
- HTTP Options
- Method:Path:
/admin/v1/Policies
- Replace a Policy
- Method: putPath:
/admin/v1/Policies/{id}
- Search Policies
- Method: getPath:
/admin/v1/Policies
- Search Policies Using POST
- Method: postPath:
/admin/v1/Policies/.search
- Update a Policy
- Method: patchPath:
/admin/v1/Policies/{id}
Policy/Policy Templates
Use this endpoint to manage the templates for a policy. This REST API is SCIM compliant.
- Create a Policy Template
- Method: postPath:
/admin/v1/PolicyTemplates
- Delete a Policy Template
- Method: deletePath:
/admin/v1/PolicyTemplates/{id}
- Get a Policy Template
- Method: getPath:
/admin/v1/PolicyTemplates/{id}
- HTTP Options
- Method:Path:
/admin/v1/PolicyTemplates
- Replace a Policy Template
- Method: putPath:
/admin/v1/PolicyTemplates/{id}
- Search a Policy Template
- Method: getPath:
/admin/v1/PolicyTemplates
- Search Policy Templates Using POST
- Method: postPath:
/admin/v1/PolicyTemplates/.search
- Update a Policy Template
- Method: patchPath:
/admin/v1/PolicyTemplates/{id}
Policy/Policy Types
Use this endpoint to manage policy types. A policy type is meta data that controls policy and rules for each type of policy, such as Authentication, Attribute Value Generation, User Name Generation, Grant, and so on. This REST API is SCIM compliant.
- Create a Policy Type
- Method: postPath:
/admin/v1/PolicyTypes
- Delete a Policy Type
- Method: deletePath:
/admin/v1/PolicyTypes/{id}
- Get a Policy Type
- Method: getPath:
/admin/v1/PolicyTypes/{id}
- HTTP Options
- Method:Path:
/admin/v1/PolicyTypes
- Replace a Policy Type
- Method: putPath:
/admin/v1/PolicyTypes/{id}
- Search Policy Types
- Method: getPath:
/admin/v1/PolicyTypes
- Search Policy Types Using POST
- Method: postPath:
/admin/v1/PolicyTypes/.search
- Update a Policy Type
- Method: patchPath:
/admin/v1/PolicyTypes/{id}
Policy/RADIUS Policy Evaluator
This REST API evaluates RADIUS Policy attached to the specified app. It is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/RadiusPolicyEvaluator
- This evaluates RADIUS Policy attached to the specified app
- Method: postPath:
/admin/v1/RadiusPolicyEvaluator
Policy/Rule Templates
Use this endpoint to manage rule templates. This REST API is SCIM compliant.
- Create a Rule Template
- Method: postPath:
/admin/v1/RuleTemplates
- Delete a Rule Template
- Method: deletePath:
/admin/v1/RuleTemplates/{id}
- Get a Rule Template
- Method: getPath:
/admin/v1/RuleTemplates/{id}
- HTTP Options
- Method:Path:
/admin/v1/RuleTemplates
- Replace a Rule Template
- Method: putPath:
/admin/v1/RuleTemplates/{id}
- Search Rule Templates
- Method: getPath:
/admin/v1/RuleTemplates
- Search Rule Templates Using POST
- Method: postPath:
/admin/v1/RuleTemplates/.search
- Update a Rule Template
- Method: patchPath:
/admin/v1/RuleTemplates/{id}
Policy/Rules
Use this endpoint to manage policy rules. A rule defines conditions to be evaluated and values that are returned if the conditions are met. This REST API is SCIM compliant.
- Create a Rule
- Method: postPath:
/admin/v1/Rules
- Delete a Rule
- Method: deletePath:
/admin/v1/Rules/{id}
- Get a Rule
- Method: getPath:
/admin/v1/Rules/{id}
- HTTP Options
- Method:Path:
/admin/v1/Rules
- Replace a Rule
- Method: putPath:
/admin/v1/Rules/{id}
- Search Rules
- Method: getPath:
/admin/v1/Rules
- Search Rules Using POST
- Method: postPath:
/admin/v1/Rules/.search
- Update a Rule
- Method: patchPath:
/admin/v1/Rules/{id}
RADIUS Proxy/RADIUS Proxy Definition
Use this endpoint to store RADIUS Proxy configurations. This REST API is SCIM compliant.
Added In Release: 20.1.3
Added In Release: 20.1.3
- Create a RADIUS Proxy
- Method: postPath:
/admin/v1/RadiusProxies
- Delete a RADIUS Proxy
- Method: deletePath:
/admin/v1/RadiusProxies/{id}
- Get a RADIUS Proxy
- Method: getPath:
/admin/v1/RadiusProxies/{id}
- HTTP Options
- Method:Path:
/admin/v1/RadiusProxies
- Replace a RADIUS Proxy
- Method: putPath:
/admin/v1/RadiusProxies/{id}
- Search RADIUS Proxies
- Method: getPath:
/admin/v1/RadiusProxies
- Search RADIUS Proxies Using POST
- Method: postPath:
/admin/v1/RadiusProxies/.search
- Update a RADIUS Proxy
- Method: patchPath:
/admin/v1/RadiusProxies/{id}
RADIUS Proxy/RADIUS Proxy Listeners
Use this endpoint to store RADIUS Proxy listener block configurations. This configuration will be transformed to RADIUS Proxy listener block configuration. This REST API is SCIM compliant.
Added In Release: 20.1.3
Added In Release: 20.1.3
- Create a RADIUS Proxy listener
- Method: postPath:
/admin/v1/RadiusProxyListeners
- Delete a RADIUS Proxy listener
- Method: deletePath:
/admin/v1/RadiusProxyListeners/{id}
- Get a RADIUS Proxy listener
- Method: getPath:
/admin/v1/RadiusProxyListeners/{id}
- HTTP Options
- Method:Path:
/admin/v1/RadiusProxyListeners
- Replace a RADIUS Proxy listener
- Method: putPath:
/admin/v1/RadiusProxyListeners/{id}
- Search RADIUS Proxy listeners
- Method: getPath:
/admin/v1/RadiusProxyListeners
- Search RADIUS Proxy listeners Using POST
- Method: postPath:
/admin/v1/RadiusProxyListeners/.search
- Update a RADIUS Proxy listener
- Method: patchPath:
/admin/v1/RadiusProxyListeners/{id}
RADIUS Proxy/RADIUS Proxy Mappings
Use this endpoint to store RADIUS Proxy mappings. This REST API is SCIM compliant.
Added In Release: 20.1.3
Added In Release: 20.1.3
- Create a RADIUS Proxy mapping
- Method: postPath:
/admin/v1/RadiusProxyMappings
- Delete a RADIUS Proxy mapping
- Method: deletePath:
/admin/v1/RadiusProxyMappings/{id}
- Get a RADIUS Proxy mapping
- Method: getPath:
/admin/v1/RadiusProxyMappings/{id}
- HTTP Options
- Method:Path:
/admin/v1/RadiusProxyMappings
- Replace a RADIUS Proxy mapping
- Method: putPath:
/admin/v1/RadiusProxyMappings/{id}
- Search RADIUS Proxy mappings
- Method: getPath:
/admin/v1/RadiusProxyMappings
- Search RADIUS Proxy mappings Using POST
- Method: postPath:
/admin/v1/RadiusProxyMappings/.search
- Update a RADIUS Proxy mapping
- Method: patchPath:
/admin/v1/RadiusProxyMappings/{id}
RADIUS Proxy/Radius Response Attributes
Use this endpoint to store RADIUS Response Attribute. This REST API is SCIM compliant.
- Create a RadiusResponseAttribute
- Method: postPath:
/admin/v1/RadiusResponseAttributes
- Delete a RadiusResponseAttribute
- Method: deletePath:
/admin/v1/RadiusResponseAttributes/{id}
- Get a RadiusResponseAttribute
- Method: getPath:
/admin/v1/RadiusResponseAttributes/{id}
- HTTP Options
- Method:Path:
/admin/v1/RadiusResponseAttributes
- Replace a RadiusResponseAttribute
- Method: putPath:
/admin/v1/RadiusResponseAttributes/{id}
- Search RadiusResponseAttribute
- Method: getPath:
/admin/v1/RadiusResponseAttributes
- Search RadiusResponseAttribute Using POST
- Method: postPath:
/admin/v1/RadiusResponseAttributes/.search
- Update a RadiusResponseAttribute
- Method: patchPath:
/admin/v1/RadiusResponseAttributes/{id}
Replication/Replication Resource Sync
This API will be invoked force push a new ReplicationLog for resourceType/resourceId for a given domain or resources matching a filter, incase a data discrepancy has been identified for a resource. This would be sync API which will initiate the backfill by generating a new ReplicationLog entry for the matched resources..
- force sync of replication log
- Method: postPath:
/replication/v1/ReplicationResourceSync
- HTTP Options
- Method:Path:
/replication/v1/ReplicationResourceSync
Reports/AppRole Membership Import Detailed Job Reports
Retrieve or search for a detailed job report on an AppRole membership import job.
- Create an AppRole Membership Import Detail Job Report
- Method: postPath:
/job/v1/AppRoleMembershipImportDetailedJobReports
- Get an AppRole Membership Import Detail Job Report
- Method: getPath:
/job/v1/AppRoleMembershipImportDetailedJobReports/{id}
- HTTP Options
- Method:Path:
/job/v1/AppRoleMembershipImportDetailedJobReports
- Search AppRole Membership Import Detail Job Reports
- Method: getPath:
/job/v1/AppRoleMembershipImportDetailedJobReports
- Search AppRole Membership Import Detail Job Reports Using POST
- Method: postPath:
/job/v1/AppRoleMembershipImportDetailedJobReports/.search
Reports/AppRole Membership Import Summary Job Reports
Use this endpoint to retrieve or search for a summary job report on an AppRole membership import job.
- Create an AppRole Membership Import Summary Job Report
- Method: postPath:
/job/v1/AppRoleMembershipImportSummaryJobReports
- Get an AppRole Membership Import Summary Job Report
- Method: getPath:
/job/v1/AppRoleMembershipImportSummaryJobReports/{id}
- HTTP Options
- Method:Path:
/job/v1/AppRoleMembershipImportSummaryJobReports
- Search AppRole Membership Import Summary Job Reports
- Method: getPath:
/job/v1/AppRoleMembershipImportSummaryJobReports
- Search AppRole Membership Import Summary Job Reports Using POST
- Method: postPath:
/job/v1/AppRoleMembershipImportSummaryJobReports/.search
Reports/Bulk User Password Reset Job Reports
Use to retrieve or search for a job report to view the status of a bulk user password reset job. This REST API is SCIM compliant.
- Create Bulk Password Reset Job Status
- Method: postPath:
/job/v1/BulkUserPasswordResetJobReports
- Delete Bulk Password Reset Job Report
- Method: deletePath:
/job/v1/BulkUserPasswordResetJobReports/{id}
- Get Bulk Password Reset Job Status
- Method: getPath:
/job/v1/BulkUserPasswordResetJobReports/{id}
- HTTP Options
- Method:Path:
/job/v1/BulkUserPasswordResetJobReports
- Search Bulk Password Reset Jobs
- Method: getPath:
/job/v1/BulkUserPasswordResetJobReports
- Search Bulk Password Reset Jobs Using POST
- Method: postPath:
/job/v1/BulkUserPasswordResetJobReports/.search
Reports/Columns
Use this endpoint to store information related to each column. This REST API is SCIM compliant.
Added In Release: 17.4.6
Added In Release: 17.4.6
- Create a Column
- Method: postPath:
/report/v1/Columns
- Delete a Column
- Method: deletePath:
/report/v1/Columns/{id}
- Get a Column
- Method: getPath:
/report/v1/Columns/{id}
- HTTP Options
- Method:Path:
/report/v1/Columns
- Replace a Column
- Method: putPath:
/report/v1/Columns/{id}
- Search Columns
- Method: getPath:
/report/v1/Columns
- Search Columns Using POST
- Method: postPath:
/report/v1/Columns/.search
- Update a Column
- Method: patchPath:
/report/v1/Columns/{id}
Reports/Grant Import Detailed Job Reports
Retrieve or search for a detailed job report on a Grant import job.
- Create a Grant Import Detail Job Report
- Method: postPath:
/job/v1/GrantImportDetailedJobReports
- Get a Grant Import Detail Job Report
- Method: getPath:
/job/v1/GrantImportDetailedJobReports/{id}
- HTTP Options
- Method:Path:
/job/v1/GrantImportDetailedJobReports
- Search Grant Import Detail Job Reports
- Method: getPath:
/job/v1/GrantImportDetailedJobReports
- Search Grant Import Detail Job Reports Using POST
- Method: postPath:
/job/v1/GrantImportDetailedJobReports/.search
Reports/Grant Import Summary Job Reports
Use this endpoint to retrieve or search for a summary job report on a Grant import job.
- Create a Grant Import Summary Job Report
- Method: postPath:
/job/v1/GrantImportSummaryJobReports
- Get a Grant Import Summary Job Report
- Method: getPath:
/job/v1/GrantImportSummaryJobReports/{id}
- HTTP Options
- Method:Path:
/job/v1/GrantImportSummaryJobReports
- Search Grant Import Summary Job Reports
- Method: getPath:
/job/v1/GrantImportSummaryJobReports
- Search Grant Import Summary Job Reports Using POST
- Method: postPath:
/job/v1/GrantImportSummaryJobReports/.search
Reports/Group Import Detailed Job Reports
Retrieve or search for a detailed job report on a Group import job.
- Create a Group Import Detail Job Report
- Method: postPath:
/job/v1/GroupImportDetailedJobReports
- Get a Group Import Detail Job Report
- Method: getPath:
/job/v1/GroupImportDetailedJobReports/{id}
- HTTP Options
- Method:Path:
/job/v1/GroupImportDetailedJobReports
- Search Group Import Detail Job Reports
- Method: getPath:
/job/v1/GroupImportDetailedJobReports
- Search Group Import Detail Job Reports Using POST
- Method: postPath:
/job/v1/GroupImportDetailedJobReports/.search
Reports/Group Import Summary Job Reports
Retrieve or search for a summary job report on a Group import job.
- Create a Group Import Summary Job Report
- Method: postPath:
/job/v1/GroupImportSummaryJobReports
- Get a Group Import Summary Job Report
- Method: getPath:
/job/v1/GroupImportSummaryJobReports/{id}
- HTTP Options
- Method:Path:
/job/v1/GroupImportSummaryJobReports
- Search Group Import Summary Job Reports
- Method: getPath:
/job/v1/GroupImportSummaryJobReports
- Search Group Import Summary Job Reports Using POST
- Method: postPath:
/job/v1/GroupImportSummaryJobReports/.search
Reports/IdcsReports
Use this endpoint to generate information that is related to each report. This REST API is SCIM compliant.
Added In Release: 17.4.6
Added In Release: 17.4.6
- Create an Oracle Identity Cloud Service Report
- Method: postPath:
/report/v1/IdcsReports
- HTTP Options
- Method:Path:
/report/v1/IdcsReports
Reports/Metered Event
Return the Metered Event
- Get Metered Event
- Method: getPath:
/report/v1/MeteredEvents/{id}
- HTTP Options
- Method:Path:
/report/v1/MeteredEvents
- Search Metered Event
- Method: getPath:
/report/v1/MeteredEvents
- Search Metered Event Using POST
- Method: postPath:
/report/v1/MeteredEvents/.search
Reports/Report Templates
Use this endpoint to manage report templates, which are the source for generating a report. This REST API is SCIM compliant.
Added In Release: 17.4.6
Added In Release: 17.4.6
- Create a Report Template
- Method: postPath:
/report/v1/ReportTemplates
- Delete a Report Template
- Method: deletePath:
/report/v1/ReportTemplates/{id}
- Get a Report Template
- Method: getPath:
/report/v1/ReportTemplates/{id}
- HTTP Options
- Method:Path:
/report/v1/ReportTemplates
- Replace a Report Template
- Method: putPath:
/report/v1/ReportTemplates/{id}
- Search Report Templates
- Method: getPath:
/report/v1/ReportTemplates
- Update a Report Template
- Method: patchPath:
/report/v1/ReportTemplates/{id}
Reports/Reports
Use Reports to view real-time activity within Oracle Identity Cloud Service. You can specify a time stamp or a custom date range using a filter for up to 90 days. Currently supported Reports include User Login, Suspicious Events, Application Access, and App Role Assignment. This REST API is SCIM compliant.
- Execute a Report
- Method: postPath:
/report/v1/Reports
- HTTP Options
- Method:Path:
/report/v1/Reports
Reports/User Import Job Reports
Retrieve or search for a job report on a User import job.
- Create a User Import Job Report
- Method: postPath:
/job/v1/UserImportJobReports
- Delete a User Import Job Report
- Method: deletePath:
/job/v1/UserImportJobReports/{id}
- Get a User Import Job Report
- Method: getPath:
/job/v1/UserImportJobReports/{id}
- HTTP Options
- Method:Path:
/job/v1/UserImportJobReports
- Search User Import Job Reports
- Method: getPath:
/job/v1/UserImportJobReports
- Search User Import Job Reports Using POST
- Method: postPath:
/job/v1/UserImportJobReports/.search
SAML/Identity Providers
Manage Identity Providers (IdP). Oracle Identity Cloud Service provides cross-domain SSO capabilities via the OASIS SAML 2.0 SSO protocol and implements two modes of operation for Federation SSO--as an IdP where the user is authenticated on behalf of remote Service Providers (SP), and as an SP where Oracle Identity Cloud Service delegates authentication to a remote IdP. As an IdP, Oracle Identity Cloud Service can integrate with multiple SPs at the same time. As an SP, Oracle Identity Cloud Service can only integrate with a single IdP at any time. This REST API is SCIM compliant.
- Create an Identity Provider
- Method: postPath:
/admin/v1/IdentityProviders
- Delete an Identity Provider
- Method: deletePath:
/admin/v1/IdentityProviders/{id}
- Get an Identity Provider
- Method: getPath:
/admin/v1/IdentityProviders/{id}
- HTTP Options
- Method:Path:
/admin/v1/IdentityProviders
- Replace an Identity Provider
- Method: putPath:
/admin/v1/IdentityProviders/{id}
- Search Identity Providers
- Method: getPath:
/admin/v1/IdentityProviders
- Search Identity Providers Using POST
- Method: postPath:
/admin/v1/IdentityProviders/.search
- Update an Identity Provider
- Method: patchPath:
/admin/v1/IdentityProviders/{id}
SAML/SAML Settings
Manage tenant-specific SAML settings. This REST API is SCIM compliant.
There is a single pre-seeded instance of SamlSettings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
There is a single pre-seeded instance of SamlSettings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
- Get SAML Settings
- Method: getPath:
/admin/v1/SamlSettings/{id}
- HTTP Options
- Method:Path:
/admin/v1/SamlSettings
- Replace SAML Settings
- Method: putPath:
/admin/v1/SamlSettings/{id}
- Search SAML Settings
- Method: getPath:
/admin/v1/SamlSettings
- Search SAML Settings Using POST
- Method: postPath:
/admin/v1/SamlSettings/.search
Secure Form Fill (SFF)/SFF Browser Extension Download URLs
This endpoint is used by a user to access the URL for downloading the Secure Form Fill browser extension. The browser plugin prompts the user to provide their credentials for form-fill applications the first time that they log in, and then logs in the user automatically after the initial log in. This REST API is SCIM compliant.
- Get the SFF Extension Download URL
- Method: getPath:
/admin/v1/SffXtnUrl
- HTTP Options
- Method:Path:
/admin/v1/SffXtnUrl
Secure Form Fill (SFF)/SFF Tool
Use this endpoint to manage tenant-specific SFF custom apps. This REST API is SCIM compliant.
Added In Release: 18.1.2
Added In Release: 18.1.2
- Get SFF Custom Apps Tool Properties
- Method: getPath:
/admin/v1/SFFCustomApps/{id}
- HTTP Options
- Method:Path:
/admin/v1/SFFCustomApps
- Replace SFF Custom Apps Tool Properties
- Method: putPath:
/admin/v1/SFFCustomApps/{id}
Security/Encryption Key
Retrieve the existing encryption keys used by Cloud Gate to encrypt cookies in JSON Web Key format (JWK).
- HTTP Options
- Method:Path:
/admin/v1/EncryptionKeys
- Retrieve Encryption Keys in JWK Format
- Method: getPath:
/admin/v1/EncryptionKeys
Security/OAuth Client Certificate
Manage OAuth client certificates present within the key store. A single certificate is returned Base64-encoded in DER format. Certificate chains are returned Base64-encoded in pkcs#7 format. This REST API is SCIM compliant.
- Create an OAuth Client Certificate
- Method: postPath:
/admin/v1/OAuthClientCertificates
- Delete an OAuth Client Certificate
- Method: deletePath:
/admin/v1/OAuthClientCertificates/{id}
- Get OAuth Client Certificates
- Method: getPath:
/admin/v1/OAuthClientCertificates/{id}
- HTTP Options
- Method:Path:
/admin/v1/OAuthClientCertificates
- Search OAuth Client Certificates
- Method: getPath:
/admin/v1/OAuthClientCertificates
- Search OAuth Client Certificates Using POST
- Method: postPath:
/admin/v1/OAuthClientCertificates/.search
Security/OAuth Partner Certificate
Manage OAuth partner certificates present within the key store. When getting an OAuth Parter Certificate, a single certificate is returned Base64-encoded in DER format. Certificate chains are returned Base64-encoded in pkcs#7 format. This REST API is SCIM compliant.
- Create an OAuth Partner Certificate
- Method: postPath:
/admin/v1/OAuthPartnerCertificates
- Delete an OAuth Partner Certificate
- Method: deletePath:
/admin/v1/OAuthPartnerCertificates/{id}
- Get an OAuth Partner Certificate
- Method: getPath:
/admin/v1/OAuthPartnerCertificates/{id}
- HTTP Options
- Method:Path:
/admin/v1/OAuthPartnerCertificates
- Search OAuth Partner Certificates
- Method: getPath:
/admin/v1/OAuthPartnerCertificates
- Search OAuth Partner Certificates Using POST
- Method: postPath:
/admin/v1/OAuthPartnerCertificates/.search
Security/Signing Certificates JWK
A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. Use this endpoint to retrieve the Tenant's signing certificate in JWK. The X.509 certificate chain parameter (x5c) returns the individual certificates within the certificate chain in Base64 format.
- HTTP Options
- Method:Path:
/admin/v1/SigningCert/jwk
- Retrieve the Tenant's Signing Certificate in JWK Format
- Method: getPath:
/admin/v1/SigningCert/jwk
Security/Trusted Partner Certificate
Manage Trusted partner certificates present within the key store. When getting an Trusted Parter Certificate, a single certificate is returned Base64-encoded in DER format. Certificate chains are returned Base64-encoded in pkcs#7 format. This REST API is SCIM compliant.
Added In Release: 2009041201
Added In Release: 2009041201
- Create an Trusted Partner Certificate
- Method: postPath:
/admin/v1/TrustedPartnerCertificates
- Delete an Trusted Partner Certificate
- Method: deletePath:
/admin/v1/TrustedPartnerCertificates/{id}
- Get an Trusted Partner Certificate
- Method: getPath:
/admin/v1/TrustedPartnerCertificates/{id}
- HTTP Options
- Method:Path:
/admin/v1/TrustedPartnerCertificates
- Search Trusted Partner Certificates
- Method: getPath:
/admin/v1/TrustedPartnerCertificates
- Search Trusted Partner Certificates Using POST
- Method: postPath:
/admin/v1/TrustedPartnerCertificates/.search
Self-Service/Me
Use this endpoint for self-profile management. This REST API is SCIM compliant.
- Get User Info
- Method: getPath:
/admin/v1/Me
- HTTP Options
- Method:Path:
/admin/v1/Me
- Replace User Info
- Method: putPath:
/admin/v1/Me
- Self Register
- Method: postPath:
/admin/v1/Me
- Update User Info
- Method: patchPath:
/admin/v1/Me
Self-Service/Me Activator
Use this endpoint to activate the user by changing the user status to Verified.
- Activate Self-Registration User
- Method: postPath:
/admin/v1/MeActivator
- HTTP Options
- Method:Path:
/admin/v1/MeActivator
Self-Service/Me Email Verified
Used in the final step of verifying a new email address. Validates the token and then marks the recovery email as verified. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/MeEmailVerified
- Self-Verify Email Address
- Method: postPath:
/admin/v1/MeEmailVerified
Self-Service/Me Email Verifier
Initiates the email validation of the user's primary email address or recovery/secondary email address. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/MeEmailVerifier
- Initiate Self-Service Email Verification
- Method: putPath:
/admin/v1/MeEmailVerifier
Self-Service/Me Password Changer
Used by the user to change their own password. This REST API is SCIM compliant. Note--Using both the urn:opc:idm:t.user.me and Custom Scope are not supported in one request.
- HTTP Options
- Method:Path:
/admin/v1/MePasswordChanger
- Self-Service Password Update
- Method: putPath:
/admin/v1/MePasswordChanger
Self-Service/Me Password Must Changer
Used by the user to change their own password when it must be changed at the next login (for example, an expired password). This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/MePasswordMustChanger
- Self-Service Password Change
- Method: postPath:
/admin/v1/MePasswordMustChanger
Self-Service/Me Password Recovery Factor Validator
Use this endpoint to validate the password recovery factors of a user.
Added In Release: 19.1.4
Added In Release: 19.1.4
- HTTP Options
- Method:Path:
/admin/v1/MePasswordRecoveryFactorValidator
- Request Self-Service Password Recovery Factor Validation
- Method: postPath:
/admin/v1/MePasswordRecoveryFactorValidator
Self-Service/Me Password Recovery Option Retriever
Retrieves the user's password recovery options. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/MePasswordRecoveryOptionRetriever
- Self-Retrieve Password Recovery Options
- Method: postPath:
/admin/v1/MePasswordRecoveryOptionRetriever
Self-Service/Me Password Reset Requestor
Initiates the forgotten password process for the user, which sends a reset password email. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/MePasswordResetRequestor
- Request a Self-Service Password Reset
- Method: postPath:
/admin/v1/MePasswordResetRequestor
Self-Service/Me Password Resetter
Resets the user's password by validating the token. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/MePasswordResetter
- Self-Service Password Reset
- Method: postPath:
/admin/v1/MePasswordResetter
Self-Service/Me Remove Pending Verification Email Data
Use this endpoint to remove pending verification email(s) and to delete an associated user token. This REST API is SCIM compliant.
Added In Release: 19.1.4
Added In Release: 19.1.4
- HTTP Options
- Method:Path:
/admin/v1/MeRemovePendingEmailVerification
- Remove Pending Verification Email and Delete Associated User Token
- Method: postPath:
/admin/v1/MeRemovePendingEmailVerification
Self-Service/Me Security Question Answer Validator
Use this endpoint to validate security questions and their corresponding answers for a user during password recovery and MFA. This endpoint can also be used by the user to update their configured security questions and answers.
- HTTP Options
- Method:Path:
/admin/v1/MeSecurityQuestionAnswerValidator
- Self-Service Validation of Security Questions and Answers
- Method: putPath:
/admin/v1/MeSecurityQuestionAnswerValidator
- Validate Answers to Security Questions During Password Recovery and MFA
- Method: postPath:
/admin/v1/MeSecurityQuestionAnswerValidator
Self-Service/Me Security Questions Retriever
Use this endpoint to retrieve security questions for a user during during password recovery and MFA. Based on the number of questions that a user is required to answer, this endpoint randomly retrieves the required number of questions. This endpoint can also be used by the user to retrieve their configured security questions.
- HTTP Options
- Method:Path:
/admin/v1/MeSecurityQuestionsRetriever
- Retrieve Security Questions During Password Recovery and MFA
- Method: postPath:
/admin/v1/MeSecurityQuestionsRetriever
- Self-Service Retrieval of Configured Security Questions
- Method: getPath:
/admin/v1/MeSecurityQuestionsRetriever
Self-Service/My Accesses
Use this endpoint to view and search for Apps that the user has access to. This endpoint supports filtering by App attributes. This REST API is SCIM compliant.
Added In Release: 17.4.6
Added In Release: 17.4.6
- HTTP Options
- Method:Path:
/admin/v1/MyAccesses
- Search My Accesses
- Method: getPath:
/admin/v1/MyAccesses
- Search My Accesses Using POST
- Method: postPath:
/admin/v1/MyAccesses/.search
Self-Service/My App Favorite Setter
Use this endpoint to favorite or unfavorite an App by setting its favorite attribute to true or false. This REST API is SCIM compliant.
- Favorite/Unfavorite an Account
- Method: putPath:
/admin/v1/MyAppFavoriteSetter/{id}
- HTTP Options
- Method:Path:
/admin/v1/MyAppFavoriteSetter
Self-Service/My Apps
A user can use this endpoint to view and search for Apps that are granted to the user. This endpoint supports filtering by App attributes. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/MyApps
- Search My Apps
- Method: getPath:
/admin/v1/MyApps
- Search My Apps Using POST
- Method: postPath:
/admin/v1/MyApps/.search
Self-Service/My Authentication Factor Enroller
This endpoint is used by an end user to initiate multi-factor authentication enrollment for supported authentication factors. This REST API is SCIM compliant.
- Create Self Service Enrollment Request for a Specific MFA Factor
- Method: postPath:
/admin/v1/MyAuthenticationFactorEnroller
- HTTP Options
- Method:Path:
/admin/v1/MyAuthenticationFactorEnroller
Self-Service/My Authentication Factor Initiator
This endpoint is used by an end user to initiate self-service MFA authentication using the requested type of authentication factor. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/MyAuthenticationFactorInitiator
- Initiate Self Service Enrollment using the Requested MFA Factor
- Method: postPath:
/admin/v1/MyAuthenticationFactorInitiator
Self-Service/My Authentication Factor Validator
This endpoint is used by an end user to initiate validation of an authentication factor. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/MyAuthenticationFactorValidator
- Validate Self Service Enrollment using the Requested MFA Factor
- Method: postPath:
/admin/v1/MyAuthenticationFactorValidator
Self-Service/My Authentication Factors Remover
This endpoint is used to delete all of the enrolled Multi-Factor Authentication channels for logged in user. This includes his registered devices, bypass codes created for him, any trusted devices for the user, and any security questions registered for the user. This REST API is SCIM compliant.
- HTTP Options
- Method:Path:
/admin/v1/MyAuthenticationFactorsRemover
- Remove All Authentication Factor Channels for a User
- Method: postPath:
/admin/v1/MyAuthenticationFactorsRemover
Self-Service/My Bypass Codes
This endpoint is used by an end user to query, update, create, and delete their bypass codes. This REST API is SCIM compliant.
- Create a Bypass Code
- Method: postPath:
/admin/v1/MyBypassCodes
- Delete a Bypass Code
- Method: deletePath:
/admin/v1/MyBypassCodes/{id}
- Get a Bypass Code
- Method: getPath:
/admin/v1/MyBypassCodes/{id}
- HTTP Options
- Method:Path:
/admin/v1/MyBypassCodes
- Search Bypass Codes
- Method: getPath:
/admin/v1/MyBypassCodes
- Search Bypass Codes Using POST
- Method: postPath:
/admin/v1/MyBypassCodes/.search
Self-Service/My Devices
This endpoint is used by an end user to query, update, and delete one or more devices associated with their account. This REST API is SCIM compliant.
- Delete a Device
- Method: deletePath:
/admin/v1/MyDevices/{id}
- Get a Device
- Method: getPath:
/admin/v1/MyDevices/{id}
- HTTP Options
- Method:Path:
/admin/v1/MyDevices
- Search Devices
- Method: getPath:
/admin/v1/MyDevices
- Update a Device
- Method: patchPath:
/admin/v1/MyDevices/{id}
Self-Service/My Social Accounts
This endpoint is used by a user to query and delete their linked social accounts. This REST API is SCIM compliant.
- Delete My Linked Social Account
- Method: deletePath:
/admin/v1/MySocialAccounts/{id}
- Get My Linked Social Account
- Method: getPath:
/admin/v1/MySocialAccounts/{id}
- HTTP Options
- Method:Path:
/admin/v1/MySocialAccounts
- Search My Linked Social Accounts
- Method: getPath:
/admin/v1/MySocialAccounts
- Search My Linked Social Accounts Using POST
- Method: postPath:
/admin/v1/MySocialAccounts/.search
Self-Service/My Trusted User Agents
This endpoint is used by an end user to query and delete their trusted devices that are used for Multi-Factor Authentication. This REST API is SCIM compliant.
- Delete a Trusted User Agent
- Method: deletePath:
/admin/v1/MyTrustedUserAgents/{id}
- Get a Trusted User Agent
- Method: getPath:
/admin/v1/MyTrustedUserAgents/{id}
- HTTP Options
- Method:Path:
/admin/v1/MyTrustedUserAgents
- Search Trusted User Agents
- Method: getPath:
/admin/v1/MyTrustedUserAgents
Single Sign-On (SSO)/HTTP Authenticator
An OAuth-protected endpoint that expects the Bearer access token in the Authorization (authZ) request header. Does the basic authentication for appid or user. This REST API is SCIM compliant.
Added In Release: 18.1.2
Added In Release: 18.1.2
- HTTP Options
- Method:Path:
/admin/v1/HTTPAuthenticator
- Validate HTTP Basic Authorization Credentials
- Method: postPath:
/admin/v1/HTTPAuthenticator
Single Sign-On (SSO)/SSO Settings
Manage tenant-specific SSO settings. This REST API is SCIM compliant.
There is a single pre-seeded instance of SsoSettings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
There is a single pre-seeded instance of SsoSettings in Oracle Identity Cloud Service.
New instances cannot be created and an existing instance cannot be removed. But, you can update a single instance via PUT or PATCH.
- Get SSO Settings
- Method: getPath:
/admin/v1/SsoSettings/{id}
- HTTP Options
- Method:Path:
/admin/v1/SsoSettings
- Replace SSO Settings
- Method: putPath:
/admin/v1/SsoSettings/{id}
- Search SSO Settings
- Method: getPath:
/admin/v1/SsoSettings
- Search SSO Settings Using POST
- Method: postPath:
/admin/v1/SsoSettings/.search
Social/My Social Account Linker
Initiate the flow to link a Social Account to an existing user in Oracle Identity Cloud Service.
- HTTP Options
- Method:Path:
/oauth2/v1/sdk/MySocialAccountLinker
- Link a Social Account to an Existing User
- Method: postPath:
/oauth2/v1/sdk/MySocialAccountLinker
Social/Social Accounts
Use this endpoint to manage user social accounts. This REST API is SCIM compliant.
- Create a Social Account
- Method: postPath:
/admin/v1/SocialAccounts
- Delete a Social Account
- Method: deletePath:
/admin/v1/SocialAccounts/{id}
- Get a Social Account
- Method: getPath:
/admin/v1/SocialAccounts/{id}
- HTTP Options
- Method:Path:
/admin/v1/SocialAccounts
- Replace a Social Account
- Method: putPath:
/admin/v1/SocialAccounts/{id}
- Search Social Accounts
- Method: getPath:
/admin/v1/SocialAccounts
- Search Social Accounts Using POST
- Method: postPath:
/admin/v1/SocialAccounts/.search
- Update a Social Account
- Method: patchPath:
/admin/v1/SocialAccounts/{id}
Social/Social Identity Providers
Use this endpoint to manage social identity providers such as Facebook, LinkedIn, Twitter, and Google. This REST API is SCIM compliant.
- Create a Social Identity Provider
- Method: postPath:
/admin/v1/SocialIdentityProviders
- Delete a Social Identity Provider
- Method: deletePath:
/admin/v1/SocialIdentityProviders/{id}
- Get a Social Identity Provider
- Method: getPath:
/admin/v1/SocialIdentityProviders/{id}
- HTTP Options
- Method:Path:
/admin/v1/SocialIdentityProviders
- Replace a Social Identity Provider
- Method: putPath:
/admin/v1/SocialIdentityProviders/{id}
- Search Social Identity Providers
- Method: getPath:
/admin/v1/SocialIdentityProviders
- Search Social Identity Providers Using POST
- Method: postPath:
/admin/v1/SocialIdentityProviders/.search
- Update a Social Identity Provider
- Method: patchPath:
/admin/v1/SocialIdentityProviders/{id}
Storage/Store Files
Create, replace, get, and delete public and private files to and from Oracle Public Cloud Storage using the Tenant scope. Files are limited to a contentType set of text/csv or application/directory.
- Create a File
- Method: postPath:
/storage/v1/Files
- Delete an Uploaded File
- Method: deletePath:
/storage/v1/Files
- HTTP Options
- Method:Path:
/storage/v1/Files
- Retrieve an Existing File
- Method: getPath:
/storage/v1/Files
- Update a File
- Method: putPath:
/storage/v1/Files
Storage/Store Images
Create, replace, and delete public images using the Tenant scope. Use the unprotected public URL to GET existing stored images.
- Create a Public Image
- Method: postPath:
/storage/v1/Images
- Delete an Uploaded Image
- Method: deletePath:
/storage/v1/Images
- HTTP Options
- Method:Path:
/storage/v1/Images
- Modify an Image
- Method: putPath:
/storage/v1/Images
- Retrieve an Existing Image
- Method: getPath:
/storage/v1/Images
Terms Of Use/Terms Of Use Statements
Use this endpoint to manage the terms of use statement, which maintains the terms of use statement that is associated with the terms of use.
Added In Release: 18.2.6
Added In Release: 18.2.6
- Create a Terms Of Use Statement
- Method: postPath:
/admin/v1/TermsOfUseStatements
- Delete a Terms Of Use Statement
- Method: deletePath:
/admin/v1/TermsOfUseStatements/{id}
- Get a Terms Of Use Statement
- Method: getPath:
/admin/v1/TermsOfUseStatements/{id}
- HTTP Options
- Method:Path:
/admin/v1/TermsOfUseStatements
- Replace a Terms Of Use Statement
- Method: putPath:
/admin/v1/TermsOfUseStatements/{id}
- Search Terms Of Use Statements
- Method: getPath:
/admin/v1/TermsOfUseStatements
- Search Terms Of Use Statements Using POST
- Method: postPath:
/admin/v1/TermsOfUseStatements/.search
- Update a Terms Of Use Statement
- Method: patchPath:
/admin/v1/TermsOfUseStatements/{id}
Terms Of Use/Terms Of Uses
Use this endpoint to manage terms of use, which maintains the terms of use statements for applications.
Added In Release: 18.2.6
Added In Release: 18.2.6
- Create a Terms Of Use
- Method: postPath:
/admin/v1/TermsOfUses
- Delete a Terms Of Use
- Method: deletePath:
/admin/v1/TermsOfUses/{id}
- Get a Terms Of Use
- Method: getPath:
/admin/v1/TermsOfUses/{id}
- HTTP Options
- Method:Path:
/admin/v1/TermsOfUses
- Replace a Terms Of Use
- Method: putPath:
/admin/v1/TermsOfUses/{id}
- Search Terms Of Uses
- Method: getPath:
/admin/v1/TermsOfUses
- Search Terms Of Uses Using POST
- Method: postPath:
/admin/v1/TermsOfUses/.search
- Update a Terms Of Use
- Method: patchPath:
/admin/v1/TermsOfUses/{id}