Package com.oracle.bmc.apiaccesscontrol

Interface PrivilegedApiControl

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    PrivilegedApiControlClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20241130")
public interface PrivilegedApiControl
extends AutoCloseable
    This service is used to restrict the control plane service apis; so that everybody won’t be able to access those apis.

    There are two main resouces defined as a part of this service 1. PrivilegedApiControl: This is created by the customer which defines which service apis are controlled and who can access it. 2. PrivilegedApiRequest: This is a request object again created by the customer operators who seek access to those privileged apis. After a request is obtained based on the PrivilegedAccessControl for which the api belongs to, either it can be approved so that the requested person can execute the service apis or it will wait for the customer to approve it.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • changePrivilegedApiControlCompartment

        ChangePrivilegedApiControlCompartmentResponse changePrivilegedApiControlCompartment​(ChangePrivilegedApiControlCompartmentRequest request)
        Moves a PrivilegedApiControl into a different compartment within the same tenancy.

        For information about moving resources between compartments, see Moving Resources to a Different Compartment.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.2/apiaccesscontrol/ChangePrivilegedApiControlCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangePrivilegedApiControlCompartment API.

      • createPrivilegedApiControl

        CreatePrivilegedApiControlResponse createPrivilegedApiControl​(CreatePrivilegedApiControlRequest request)
        Creates a PrivilegedApiControl.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.2/apiaccesscontrol/CreatePrivilegedApiControlExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreatePrivilegedApiControl API.

      • deletePrivilegedApiControl

        DeletePrivilegedApiControlResponse deletePrivilegedApiControl​(DeletePrivilegedApiControlRequest request)
        Deletes a PrivilegedApiControl.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.2/apiaccesscontrol/DeletePrivilegedApiControlExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeletePrivilegedApiControl API.

      • getPrivilegedApiControl

        GetPrivilegedApiControlResponse getPrivilegedApiControl​(GetPrivilegedApiControlRequest request)
        Gets information about a PrivilegedApiControl.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.2/apiaccesscontrol/GetPrivilegedApiControlExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPrivilegedApiControl API.

      • listPrivilegedApiControls

        ListPrivilegedApiControlsResponse listPrivilegedApiControls​(ListPrivilegedApiControlsRequest request)
        Gets a list of PrivilegedApiControls.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.2/apiaccesscontrol/ListPrivilegedApiControlsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPrivilegedApiControls API.

      • updatePrivilegedApiControl

        UpdatePrivilegedApiControlResponse updatePrivilegedApiControl​(UpdatePrivilegedApiControlRequest request)
        Updates a PrivilegedApiControl.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.2/apiaccesscontrol/UpdatePrivilegedApiControlExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePrivilegedApiControl API.

      • getWaiters

        PrivilegedApiControlWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        PrivilegedApiControlPaginators getPaginators()
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Returns:
        The service paginators.