Package com.oracle.bmc.apiaccesscontrol.model

Class CreatePrivilegedApiRequestDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20241130")
public final class CreatePrivilegedApiRequestDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    An Oracle operator raises privilegedApi request when they need access to any infrastructure resource governed by PrivilegedApi Access Control.

    The privilegedApi request identifies the target resource and the set of operator actions. Access request handling depends upon the Operator Control that governs the target resource, and the set of operator actions listed for approval in the access request. If all of the operator actions listed in the privilegedApi request are in the pre-approved list in the PrivilegedApi Control that governs the target resource, then the privilegedApi request is automatically approved. If not, then the privilegedApi request requires explicit approval from the approver group specified by the PrivilegedApi Control governing the target resource.

    You can approve or reject an privilegedApi request. You can also revoke the approval of an already approved privilegedApi request. While creating an access request, the operator specifies the duration of access. You have the option to approve the entire duration or reduce or even increase the time duration. An operator can also request for an extension. The approval for such an extension is processed the same way the original privilegedApi request was processed.
    Note: Objects should always be created or deserialized using the CreatePrivilegedApiRequestDetails.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 CreatePrivilegedApiRequestDetails.Builder, which maintain a set of all explicitly set fields called CreatePrivilegedApiRequestDetails.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

      • getReasonSummary

        public String getReasonSummary()
        Summary comment by the operator creating the access request.
        Returns:
        the value

      • getCompartmentId

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

      • getResourceId

        public String getResourceId()
        The OCID of the target resource associated with the access request.

        The operator raises an access request to get approval to access the target resource.

        Returns:
        the value

      • getSubResourceNameList

        public List<String> getSubResourceNameList()
        The subresource names requested for approval.
        Returns:
        the value

      • getPrivilegedOperationList

        public List<PrivilegedApiRequestOperationDetails> getPrivilegedOperationList()
        List of api names, attributes for which approval is sought by the user.
        Returns:
        the value

      • getNotificationTopicId

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

      • getReasonDetail

        public String getReasonDetail()
        Reason in detail for which the operator is requesting access on the target resource.
        Returns:
        the value

      • getSeverity

        public PrivilegedApiRequestSeverity getSeverity()
        Priority assigned to the access request by the operator
        Returns:
        the value

      • getDurationInHrs

        public Integer getDurationInHrs()
        Duration in hours for which access is sought on the target resource.
        Returns:
        the value

      • getTicketNumbers

        public List<String> getTicketNumbers()
        A list of ticket numbers related to this Privileged Api Access Request, e.g.

        Service Request (SR) number and JIRA ticket number.

        Returns:
        the value

      • getTimeRequestedForFutureAccess

        public Date getTimeRequestedForFutureAccess()
        Time in future when the user for the privilegedApi request needs to be created in RFC 3339timestamp format.

        Example: ‘2020-05-22T21:10:29.600Z’

        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

      • 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