Class PrivilegedApiRequest

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.

Inheritance

object

PrivilegedApiRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ApiaccesscontrolService.Models

Assembly: OCI.DotNetSDK.Apiaccesscontrol.dll

Syntax

public class PrivilegedApiRequest

Properties

ApproverDetails

Declaration

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

Property Value

Type	Description
List<ApproverDetail>	Contains the approver details who have approved the privilegedApi Request during the initial request.

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. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	Name of the privilegedApi control. The name must be unique.

DurationInHrs

Declaration

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

Property Value

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

EntityType

Declaration

[JsonProperty(PropertyName = "entityType")]
public string EntityType { get; set; }

Property Value

Type	Description
string	entityType of resource for which the AccessRequest is applicable

FreeformTags

Declaration

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

Property Value

Type	Description
Dictionary<string, string>	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"}

Id

Declaration

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

Property Value

Type	Description
string	The OCID of the privilegedApi request.

Remarks

Required

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 PrivilegedApiRequest.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
PrivilegedApiRequest.LifecycleStateEnum?	The current state of the PrivilegedApiRequest.

NotificationTopicId

Declaration

[JsonProperty(PropertyName = "notificationTopicId")]
public string NotificationTopicId { get; set; }

Property Value

Type	Description
string	The OCID of the OCI Notification topic to publish messages related to this privileged api request.

NumberOfApproversRequired

Declaration

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

Property Value

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

PrivilegedApiControlId

Declaration

[JsonProperty(PropertyName = "privilegedApiControlId")]
public string PrivilegedApiControlId { get; set; }

Property Value

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

PrivilegedApiControlName

Declaration

[JsonProperty(PropertyName = "privilegedApiControlName")]
public string PrivilegedApiControlName { get; set; }

Property Value

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

PrivilegedOperationList

Declaration

[JsonProperty(PropertyName = "privilegedOperationList")]
public List<PrivilegedApiRequestOperationDetails> PrivilegedOperationList { get; set; }

Property Value

Type	Description
List<PrivilegedApiRequestOperationDetails>	List of api names, attributes for which approval is sought by the user.

ReasonDetail

Declaration

[JsonProperty(PropertyName = "reasonDetail")]
public string ReasonDetail { get; set; }

Property Value

Type	Description
string	Reason in Detail for which the operator is requesting access on the target resource.

ReasonSummary

Declaration

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

Property Value

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

Remarks

Required

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.

RequestedBy

Declaration

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

Property Value

Type	Description
List<string>	List of Users who has created this privilegedApiRequest.

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	resourceName for which the PrivilegedApiRequest is applicable

ResourceType

Declaration

[JsonProperty(PropertyName = "resourceType")]
public string ResourceType { get; set; }

Property Value

Type	Description
string	resourceType for which the AccessRequest is applicable

Severity

Declaration

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

Property Value

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

State

Declaration

[Required(ErrorMessage = "State is required.")]
[JsonProperty(PropertyName = "state")]
[JsonConverter(typeof(ResponseEnumConverter))]
public PrivilegedApiRequest.StateEnum? State { get; set; }

Property Value

Type	Description
PrivilegedApiRequest.StateEnum?	The current state of the Access Request.

Remarks

Required

StateDetails

Declaration

[JsonProperty(PropertyName = "stateDetails")]
public string StateDetails { get; set; }

Property Value

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

SubResourceNameList

Declaration

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

Property Value

Type	Description
List<string>	The subresource names requested for approval.

SystemTags

Declaration

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

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TicketNumbers

Declaration

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

Property Value

Type	Description
List<string>	A list of ticket numbers related to this Privileged Api Access Request, e.g. Service Request (SR) number and JIRA ticket number.

TimeCreated

Declaration

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

Property Value

Type	Description
DateTime?	Time when the privilegedApi request was created in RFC 3339timestamp 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 privilegedApi request needs to be created in RFC 3339timestamp format. Example: '2020-05-22T21:10:29.600Z'

TimeUpdated

Declaration

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

Property Value

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