Class PrivilegedApiControl

A PrivilegedApiControl is a kind of Policy definition which provides details about which operations needs to be secure; who can approve a privilegedApiRequest requesting for a particular operation, whether the operations needs to be approved by customer or is it preApproved.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Inheritance

object

PrivilegedApiControl

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 PrivilegedApiControl

Properties

ApproverGroupIdList

Declaration

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

Property Value

Type	Description
List<string>	List of IAM user group ids who can approve an privilegedApi request associated with a target resource under the governance of this operator control.

CompartmentId

Declaration

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

Property Value

Type	Description
string	The OCID of the compartment.

Remarks

Required

DefinedTags

Declaration

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

Remarks

Required

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	Description of privilegedApi control.

DisplayName

Declaration

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

Property Value

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

Remarks

Required

FreeformTags

Declaration

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

Remarks

Required

Id

Declaration

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

Property Value

Type	Description
string	The OCID of the PrivilegedApiControl.

Remarks

Required

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { 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.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public PrivilegedApiControl.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

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

Remarks

Required

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 Control.

NumberOfApprovers

Declaration

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

Property Value

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

PrivilegedOperationList

Declaration

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

Property Value

Type	Description
List<PrivilegedApiDetails>	List of privileged operations/apis. These operations/apis will be treaated as secured, once enabled by the Privileged API Managment for a resource. Any of these operations, if needs to be executed, needs to be raised as a PrivilegedApi Request which needs to be approved by customers or it can be pre-approved.

ResourceType

Declaration

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

Property Value

Type	Description
string	resourceType for which the PrivilegedApiControl is applicable

Resources

Declaration

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

Property Value

Type	Description
List<string>	contains Resource details

State

Declaration

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

Property Value

Type	Description
string	The current state of the PrivilegedApiControl.

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.

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

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required

TimeDeleted

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

TimeUpdated

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z