Package com.oracle.bmc.apiaccesscontrol.model

Class PrivilegedApiControl

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20241130")
public final class PrivilegedApiControl
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A PrivilegedApiControl is a kind of Policy definition which provides details about which operations needs to be secure; who can approve a privilegedApiRequest requesting for a particular operation, whether the operations needs to be approved by customer or is it preApproved.

    To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
    Note: Objects should always be created or deserialized using the PrivilegedApiControl.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the PrivilegedApiControl.Builder, which maintain a set of all explicitly set fields called PrivilegedApiControl.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the PrivilegedApiControl.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        Name of the privilegedApi control.

        The name must be unique.

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment.
        Returns:
        the value

      • getDescription

        public String getDescription()
        Description of privilegedApi control.
        Returns:
        the value

      • getNotificationTopicId

        public String getNotificationTopicId()
        The OCID of the OCI Notification topic to publish messages related to this Privileged Api Control.
        Returns:
        the value

      • getApproverGroupIdList

        public List<String> getApproverGroupIdList()
        List of IAM user group ids who can approve an privilegedApi request associated with a target resource under the governance of this operator control.
        Returns:
        the value

      • getResourceType

        public String getResourceType()
        resourceType for which the PrivilegedApiControl is applicable
        Returns:
        the value

      • getResources

        public List<String> getResources()
        contains Resource details
        Returns:
        the value

      • getPrivilegedOperationList

        public List<PrivilegedApiDetails> getPrivilegedOperationList()
        List of privileged operations/apis.

        These operations/apis will be treaated as secured, once enabled by the Privileged API Managment for a resource. Any of these operations, if needs to be executed, needs to be raised as a PrivilegedApi Request which needs to be approved by customers or it can be pre-approved.

        Returns:
        the value

      • getNumberOfApprovers

        public Integer getNumberOfApprovers()
        Number of approvers required to approve an privilegedApi request.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getTimeDeleted

        public Date getTimeDeleted()
        The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getState

        public String getState()
        The current state of the PrivilegedApiControl.
        Returns:
        the value

      • getStateDetails

        public String getStateDetails()
        A message that describes the current state of the PrivilegedApiControl in more detail.

        For example, can be used to provide actionable information for a resource in the Failed state.

        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message that describes the current state of the PrivilegedApiControl in more detail.

        For example, can be used to provide actionable information for a resource in the Failed state.

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

        Example: {"Department": "Finance"}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        System tags for this resource.

        Each key is predefined and scoped to a namespace.

        Example: {"orcl-cloud": {"free-tier-retained": "true"}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel