Class AccessRequest

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.

Inheritance

object

AccessRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OperatoraccesscontrolService.Models

Assembly: OCI.DotNetSDK.Operatoraccesscontrol.dll

Syntax

public class AccessRequest

Properties

AccessReasonSummary

Declaration

[Required(ErrorMessage = "AccessReasonSummary is required.")]
[JsonProperty(PropertyName = "accessReasonSummary")]
public string AccessReasonSummary { get; set; }

Property Value

Type	Description
string	Summary comment by the operator creating the access request.

Remarks

Required

ActionRequestsList

Declaration

[JsonProperty(PropertyName = "actionRequestsList")]
public List<string> ActionRequestsList { get; set; }

Property Value

Type	Description
List<string>	List of operator actions for which approval is sought by the operator user.

ApproverComment

Declaration

[JsonProperty(PropertyName = "approverComment")]
public string ApproverComment { get; set; }

Property Value

Type	Description
string	The last recent Comment entered by the approver of the request.

ApproverDetails

Declaration

[JsonProperty(PropertyName = "approverDetails")]
public List<ApproverDetail> ApproverDetails { get; set; }

Property Value

Type	Description
List<ApproverDetail>	Contains the user ids who have approved the accessRequest for extension.

AuditType

Declaration

[JsonProperty(PropertyName = "auditType")]
public List<string> AuditType { get; set; }

Property Value

Type	Description
List<string>	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.

ClosureComment

Declaration

[JsonProperty(PropertyName = "closureComment")]
public string ClosureComment { get; set; }

Property Value

Type	Description
string	The comment entered by the operator while closing the request.

CompartmentId

Declaration

[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment that contains the access request.

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace.

Duration

Declaration

[JsonProperty(PropertyName = "duration")]
public int? Duration { get; set; }

Property Value

Type	Description
int?	Duration in hours for which access is sought on the target resource.

ExtendDuration

Declaration

[JsonProperty(PropertyName = "extendDuration")]
public int? ExtendDuration { get; set; }

Property Value

Type	Description
int?	Duration in hours for which extension access is sought on the target resource.

ExtensionApproverDetails

Declaration

[JsonProperty(PropertyName = "extensionApproverDetails")]
public List<ApproverDetail> ExtensionApproverDetails { get; set; }

Property Value

Type	Description
List<ApproverDetail>	Contains the user ids who have approved the accessRequest for extension.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the access request.

Remarks

Required

IsAutoApproved

Declaration

[JsonProperty(PropertyName = "isAutoApproved")]
public bool? IsAutoApproved { get; set; }

Property Value

Type	Description
bool?	Whether the access request was automatically approved.

IsValidateAssignment

Declaration

[JsonProperty(PropertyName = "isValidateAssignment")]
public bool? IsValidateAssignment { get; set; }

Property Value

Type	Description
bool?	Whether the access request was requested for Validate Assignment.

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	more in detail about the lifeCycleState.

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AccessRequestLifecycleStates? LifecycleState { get; set; }

Property Value

Type	Description
AccessRequestLifecycleStates?	The current state of the AccessRequest.

NumberOfApprovers

Declaration

[JsonProperty(PropertyName = "numberOfApprovers")]
public int? NumberOfApprovers { get; set; }

Property Value

Type	Description
int?	Number of approvers who have authorized an access request.

NumberOfApproversRequired

Declaration

[JsonProperty(PropertyName = "numberOfApproversRequired")]
public int? NumberOfApproversRequired { get; set; }

Property Value

Type	Description
int?	Number of approvers required to approve an access request.

NumberOfExtensionApprovers

Declaration

[JsonProperty(PropertyName = "numberOfExtensionApprovers")]
public int? NumberOfExtensionApprovers { get; set; }

Property Value

Type	Description
int?	Number of approvers who have authorized an access request for extension.

OpctlAdditionalMessage

Declaration

[JsonProperty(PropertyName = "opctlAdditionalMessage")]
public string OpctlAdditionalMessage { get; set; }

Property Value

Type	Description
string	Additional message specific to the access request that can be specified by the approver at the time of approval.

OpctlId

Declaration

[JsonProperty(PropertyName = "opctlId")]
public string OpctlId { get; set; }

Property Value

Type	Description
string	The OCID of the operator control governing the target resource.

OpctlName

Declaration

[JsonProperty(PropertyName = "opctlName")]
public string OpctlName { get; set; }

Property Value

Type	Description
string	Name of the Operator control governing the target resource.

OperatorId

Declaration

[JsonProperty(PropertyName = "operatorId")]
public string OperatorId { get; set; }

Property Value

Type	Description
string	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.

Reason

Declaration

[JsonProperty(PropertyName = "reason")]
public string Reason { get; set; }

Property Value

Type	Description
string	Summary reason for which the operator is requesting access on the target resource.

RequestId

Declaration

[JsonProperty(PropertyName = "requestId")]
public string RequestId { get; set; }

Property Value

Type	Description
string	This is an automatic identifier generated by the system which is easier for human comprehension.

ResourceId

Declaration

[Required(ErrorMessage = "ResourceId is required.")]
[JsonProperty(PropertyName = "resourceId")]
public string ResourceId { get; set; }

Property Value

Type	Description
string	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.

Remarks

Required

ResourceName

Declaration

[JsonProperty(PropertyName = "resourceName")]
public string ResourceName { get; set; }

Property Value

Type	Description
string	The name of the target resource.

ResourceType

Declaration

[JsonProperty(PropertyName = "resourceType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ResourceTypes? ResourceType { get; set; }

Property Value

Type	Description
ResourceTypes?	resourceType for which the AccessRequest is applicable

Severity

Declaration

[JsonProperty(PropertyName = "severity")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AccessRequestSeverities? Severity { get; set; }

Property Value

Type	Description
AccessRequestSeverities?	Priority assigned to the access request by the operator

SubResourceList

Declaration

[JsonProperty(PropertyName = "subResourceList")]
public List<string> SubResourceList { get; set; }

Property Value

Type	Description
List<string>	The subresources requested for approval.

SystemMessage

Declaration

[JsonProperty(PropertyName = "systemMessage")]
public string SystemMessage { get; set; }

Property Value

Type	Description
string	System message that will be displayed to the operator at login to the target resource.

TimeOfCreation

Declaration

[JsonProperty(PropertyName = "timeOfCreation")]
public DateTime? TimeOfCreation { get; set; }

Property Value

Type	Description
DateTime?	Time when the access request was created in RFC 3339timestamp format. Example: '2020-05-22T21:10:29.600Z'

TimeOfModification

Declaration

[JsonProperty(PropertyName = "timeOfModification")]
public DateTime? TimeOfModification { get; set; }

Property Value

Type	Description
DateTime?	Time when the access request was last modified in RFC 3339timestamp format. Example: '2020-05-22T21:10:29.600Z'

TimeOfUserCreation

Declaration

[JsonProperty(PropertyName = "timeOfUserCreation")]
public DateTime? TimeOfUserCreation { get; set; }

Property Value

Type	Description
DateTime?	The time when access request is scheduled to be approved in RFC 3339 timestamp format.Example: '2020-05-22T21:10:29.600Z'

TimeRequestedForFutureAccess

Declaration

[JsonProperty(PropertyName = "timeRequestedForFutureAccess")]
public DateTime? TimeRequestedForFutureAccess { get; set; }

Property Value

Type	Description
DateTime?	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'

UserId

Declaration

[JsonProperty(PropertyName = "userId")]
public string UserId { get; set; }

Property Value

Type	Description
string	The OCID of the user that last modified the access request.

WorkflowId

Declaration

[JsonProperty(PropertyName = "workflowId")]
public List<string> WorkflowId { get; set; }

Property Value

Type	Description
List<string>	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.