Show / Hide Table of Contents

Class CreatePrivilegedApiRequestDetails

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
CreatePrivilegedApiRequestDetails
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 CreatePrivilegedApiRequestDetails

Properties

CompartmentId

Declaration
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment.

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"}}

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.

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"}

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.

PrivilegedOperationList

Declaration
[Required(ErrorMessage = "PrivilegedOperationList is required.")]
[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.

Remarks

Required

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

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

Severity

Declaration
[JsonProperty(PropertyName = "severity")]
[JsonConverter(typeof(StringEnumConverter))]
public PrivilegedApiRequestSeverity? Severity { get; set; }
Property Value
Type Description
PrivilegedApiRequestSeverity?

Priority assigned to the access request by the operator

SubResourceNameList

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

The subresource names requested for approval.

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.

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'

In this article
Back to top