@Generated(value="OracleSDKGenerator",
comments="API Version: 20200630")
public final class AccessRequest
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
An Oracle operator raises access request when they need access to any infrastructure resource governed by Operator Access Control. The access 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 access request are in the pre-approved list in the Operator Control that governs the target resource, then the access request is automatically approved. If not, then the access request requires explicit approval from the approver group specified by the Operator Control governing the target resource.
You can approve or reject an access request. You can also revoke the approval of an already
approved access 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 access request was processed.
Note: Objects should always be created or deserialized using the AccessRequest.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 AccessRequest.Builder, which maintain a
set of all explicitly set fields called AccessRequest.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
AccessRequest.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
AccessRequest(String id,
String requestId,
String accessReasonSummary,
String operatorId,
String resourceId,
String resourceName,
List<String> subResourceList,
String compartmentId,
ResourceTypes resourceType,
List<String> actionRequestsList,
String reason,
AccessRequestSeverities severity,
Integer duration,
Integer extendDuration,
List<String> workflowId,
Boolean isAutoApproved,
AccessRequestLifecycleStates lifecycleState,
String lifecycleDetails,
Date timeOfCreation,
Date timeOfModification,
Date timeOfUserCreation,
String userId,
String approverComment,
String closureComment,
String opctlId,
String opctlName,
String systemMessage,
String opctlAdditionalMessage,
List<String> auditType,
Integer numberOfApproversRequired,
Integer numberOfApprovers,
Integer numberOfExtensionApprovers,
List<ApproverDetail> approverDetails,
List<ApproverDetail> extensionApproverDetails,
Boolean isValidateAssignment,
Date timeRequestedForFutureAccess,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AccessRequest.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getAccessReasonSummary()
Summary comment by the operator creating the access request.
|
List<String> |
getActionRequestsList()
List of operator actions for which approval is sought by the operator user.
|
String |
getApproverComment()
The last recent Comment entered by the approver of the request.
|
List<ApproverDetail> |
getApproverDetails()
Contains the user ids who have approved the accessRequest for extension.
|
List<String> |
getAuditType()
Specifies the type of auditing to be enabled.
|
String |
getClosureComment()
The comment entered by the operator while closing the request.
|
String |
getCompartmentId()
The OCID of the compartment that contains the access request.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
Integer |
getDuration()
Duration in hours for which access is sought on the target resource.
|
Integer |
getExtendDuration()
Duration in hours for which extension access is sought on the target resource.
|
List<ApproverDetail> |
getExtensionApproverDetails()
Contains the user ids who have approved the accessRequest for extension.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
String |
getId()
The OCID of the access request.
|
Boolean |
getIsAutoApproved()
Whether the access request was automatically approved.
|
Boolean |
getIsValidateAssignment()
Whether the access request was requested for Validate Assignment.
|
String |
getLifecycleDetails()
more in detail about the lifeCycleState.
|
AccessRequestLifecycleStates |
getLifecycleState()
The current state of the AccessRequest.
|
Integer |
getNumberOfApprovers()
Number of approvers who have authorized an access request.
|
Integer |
getNumberOfApproversRequired()
Number of approvers required to approve an access request.
|
Integer |
getNumberOfExtensionApprovers()
Number of approvers who have authorized an access request for extension.
|
String |
getOpctlAdditionalMessage()
Additional message specific to the access request that can be specified by the approver at
the time of approval.
|
String |
getOpctlId()
The OCID of the operator control governing the target resource.
|
String |
getOpctlName()
Name of the Operator control governing the target resource.
|
String |
getOperatorId()
A unique identifier associated with the operator who raised the request.
|
String |
getReason()
Summary reason for which the operator is requesting access on the target resource.
|
String |
getRequestId()
This is an automatic identifier generated by the system which is easier for human
comprehension.
|
String |
getResourceId()
The OCID of the target resource associated with the access request.
|
String |
getResourceName()
The name of the target resource.
|
ResourceTypes |
getResourceType()
resourceType for which the AccessRequest is applicable
|
AccessRequestSeverities |
getSeverity()
Priority assigned to the access request by the operator
|
List<String> |
getSubResourceList()
The subresources requested for approval.
|
String |
getSystemMessage()
System message that will be displayed to the operator at login to the target resource.
|
Date |
getTimeOfCreation()
Time when the access request was created in RFC
3339timestamp format.
|
Date |
getTimeOfModification()
Time when the access request was last modified in RFC
3339timestamp format.
|
Date |
getTimeOfUserCreation()
The time when access request is scheduled to be approved in RFC
3339 timestamp format.Example:
‘2020-05-22T21:10:29.600Z’
|
Date |
getTimeRequestedForFutureAccess()
Time in future when the user for the access request needs to be created in RFC
3339timestamp format.
|
String |
getUserId()
The OCID of the user that last modified the access request.
|
List<String> |
getWorkflowId()
The OCID of the workflow associated with the access request.
|
int |
hashCode() |
AccessRequest.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","requestId","accessReasonSummary","operatorId","resourceId","resourceName","subResourceList","compartmentId","resourceType","actionRequestsList","reason","severity","duration","extendDuration","workflowId","isAutoApproved","lifecycleState","lifecycleDetails","timeOfCreation","timeOfModification","timeOfUserCreation","userId","approverComment","closureComment","opctlId","opctlName","systemMessage","opctlAdditionalMessage","auditType","numberOfApproversRequired","numberOfApprovers","numberOfExtensionApprovers","approverDetails","extensionApproverDetails","isValidateAssignment","timeRequestedForFutureAccess","freeformTags","definedTags"}) public AccessRequest(String id, String requestId, String accessReasonSummary, String operatorId, String resourceId, String resourceName, List<String> subResourceList, String compartmentId, ResourceTypes resourceType, List<String> actionRequestsList, String reason, AccessRequestSeverities severity, Integer duration, Integer extendDuration, List<String> workflowId, Boolean isAutoApproved, AccessRequestLifecycleStates lifecycleState, String lifecycleDetails, Date timeOfCreation, Date timeOfModification, Date timeOfUserCreation, String userId, String approverComment, String closureComment, String opctlId, String opctlName, String systemMessage, String opctlAdditionalMessage, List<String> auditType, Integer numberOfApproversRequired, Integer numberOfApprovers, Integer numberOfExtensionApprovers, List<ApproverDetail> approverDetails, List<ApproverDetail> extensionApproverDetails, Boolean isValidateAssignment, Date timeRequestedForFutureAccess, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static AccessRequest.Builder builder()
Create a new builder.
public AccessRequest.Builder toBuilder()
public String getId()
The OCID of the access request.
public String getRequestId()
This is an automatic identifier generated by the system which is easier for human comprehension.
public String getAccessReasonSummary()
Summary comment by the operator creating the access request.
public String getOperatorId()
A unique identifier associated with the operator who raised the request. This identifier can not be used directly to identify the operator. You need to provide this identifier if you would like Oracle to provide additional information about the operator action within Oracle tenancy.
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.
public String getResourceName()
The name of the target resource.
public List<String> getSubResourceList()
The subresources requested for approval.
public String getCompartmentId()
The OCID of the compartment that contains the access request.
public ResourceTypes getResourceType()
resourceType for which the AccessRequest is applicable
public List<String> getActionRequestsList()
List of operator actions for which approval is sought by the operator user.
public String getReason()
Summary reason for which the operator is requesting access on the target resource.
public AccessRequestSeverities getSeverity()
Priority assigned to the access request by the operator
public Integer getDuration()
Duration in hours for which access is sought on the target resource.
public Integer getExtendDuration()
Duration in hours for which extension access is sought on the target resource.
public List<String> getWorkflowId()
The OCID of the workflow associated with the access request. This is needed if you want to contact Oracle Support for a stuck access request or for an access request that encounters an internal error.
public Boolean getIsAutoApproved()
Whether the access request was automatically approved.
public AccessRequestLifecycleStates getLifecycleState()
The current state of the AccessRequest.
public String getLifecycleDetails()
more in detail about the lifeCycleState.
public Date getTimeOfCreation()
Time when the access request was created in RFC 3339timestamp format. Example: ‘2020-05-22T21:10:29.600Z’
public Date getTimeOfModification()
Time when the access request was last modified in RFC 3339timestamp format. Example: ‘2020-05-22T21:10:29.600Z’
public Date getTimeOfUserCreation()
The time when access request is scheduled to be approved in RFC 3339 timestamp format.Example: ‘2020-05-22T21:10:29.600Z’
public String getUserId()
The OCID of the user that last modified the access request.
public String getApproverComment()
The last recent Comment entered by the approver of the request.
public String getClosureComment()
The comment entered by the operator while closing the request.
public String getOpctlId()
The OCID of the operator control governing the target resource.
public String getOpctlName()
Name of the Operator control governing the target resource.
public String getSystemMessage()
System message that will be displayed to the operator at login to the target resource.
public String getOpctlAdditionalMessage()
Additional message specific to the access request that can be specified by the approver at the time of approval.
public List<String> getAuditType()
Specifies the type of auditing to be enabled. There are two levels of auditing: command-level and keystroke-level. By default, auditing is enabled at the command level i.e., each command issued by the operator is audited. When keystroke-level is chosen, in addition to command level logging, key strokes are also logged.
public Integer getNumberOfApproversRequired()
Number of approvers required to approve an access request.
public Integer getNumberOfApprovers()
Number of approvers who have authorized an access request.
public Integer getNumberOfExtensionApprovers()
Number of approvers who have authorized an access request for extension.
public List<ApproverDetail> getApproverDetails()
Contains the user ids who have approved the accessRequest for extension.
public List<ApproverDetail> getExtensionApproverDetails()
Contains the user ids who have approved the accessRequest for extension.
public Boolean getIsValidateAssignment()
Whether the access request was requested for Validate Assignment.
public Date getTimeRequestedForFutureAccess()
Time in future when the user for the access request needs to be created in RFC 3339timestamp format. Example: ‘2020-05-22T21:10:29.600Z’
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.