Oracle Cloud Infrastructure Documentation

Manage Oracle API Access Control Resources Using the APIs

Oracle API Access Control application programming interfaces (APIs) assist with managing and auditing access control to your Oracle Cloud Infrastructure compartments.

For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface. For more information about API Reference and Endpoints, see Oracle API Access Control API.

Using the API to Manage API Metadata

Review the list of REST API endpoints to manage API Metadata.

  • ListApiMetadata:
    • Returns a list of API metadata for the specified compartment ID.
    • Returns a list of API metadata grouped by entity types for the specified compartment ID.
  • GetApiMetadata: Retrieves API metadata for the specified ID.

Using the API to Manage Privileged API Controls

Review the list of REST API endpoints to manage Privileged API Controls.

  • ListPrivilegedApiControls: Returns a list of Privileged API Controls for the specified compartment ID.
  • CreatePrivilegedApiControl: Creates a Privileged API Control.
  • GetPrivilegedApiControl: Retrieves the details of the specified Privileged API Control ID.
  • UpdatePrivilegedApiControl: Updates the details of the specified Privileged API Control ID.
    Note

    UpdatePrivilegedApiControl is a privileged operation. The service will automatically raise an Access Request and require a second approver to approve updating the Privileged API Control. The service does not provide a method to override this control.
  • DeletePrivilegedApiControl: Deletes the Privileged API Control for the specified ID.
  • ChangePrivilegedApiControlCompartment: Moves the Privileged API Control with the specified ID to a different compartment.

Using the API to Manage Privileged API Requests

Review the list of REST API endpoints to manage Privileged API Requests.

  • CreatePrivilegedApiRequest: Creates a Privileged API Request.
  • ListPrivilegedApiRequests: Returns a list of all Privileged API Requests for the specified compartment ID.
  • GetPrivilegedApiRequest: Retrieves the details of the specified Privileged API Request ID.
  • ApprovePrivilegedApiRequest: Approves a Privileged API Request.
  • RejectPrivilegedApiRequest: Rejects a Privileged API Request.
  • RevokePrivilegedApiRequest: Revokes an already approved Privileged API Request.
  • ClosePrivilegedApiRequest: Closes a Privileged API Request.

Using the API to Manage Privileged API Work Requests

Review the list of REST API endpoints to manage Privileged API Work Requests.

  • ListWorkRequests: Returns a list of Privileged API Work Requests for the specified compartment ID.
  • GetWorkRequest: Retrieves the details of the specified Privileged API Work Request ID.
  • CancelWorkRequest: Cancels the Privileged API Work Request for the specified ID.
  • ListWorkRequestErrors: Retrieves a (paginated) list of errors for the specified Privileged API Work Request ID.
  • ListWorkRequestLogs: Retrieves a list of logs for the specified Privileged API Work Request ID.