1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. oci
  5. getApiaccesscontrolPrivilegedApiControl
Oracle Cloud Infrastructure v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi
oci logo
Oracle Cloud Infrastructure v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi

    This data source provides details about a specific Privileged Api Control resource in Oracle Cloud Infrastructure Apiaccesscontrol service.

    Gets information about a PrivilegedApiControl.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testPrivilegedApiControl = oci.oci.getApiaccesscontrolPrivilegedApiControl({
        privilegedApiControlId: testPrivilegedApiControlOciApiaccesscontrolPrivilegedApiControl.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_privileged_api_control = oci.oci.get_apiaccesscontrol_privileged_api_control(privileged_api_control_id=test_privileged_api_control_oci_apiaccesscontrol_privileged_api_control["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/oci"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := oci.LookupApiaccesscontrolPrivilegedApiControl(ctx, &oci.LookupApiaccesscontrolPrivilegedApiControlArgs{
    			PrivilegedApiControlId: testPrivilegedApiControlOciApiaccesscontrolPrivilegedApiControl.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testPrivilegedApiControl = Oci.Oci.GetApiaccesscontrolPrivilegedApiControl.Invoke(new()
        {
            PrivilegedApiControlId = testPrivilegedApiControlOciApiaccesscontrolPrivilegedApiControl.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.oci.OciFunctions;
    import com.pulumi.oci.oci.inputs.GetApiaccesscontrolPrivilegedApiControlArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var testPrivilegedApiControl = OciFunctions.getApiaccesscontrolPrivilegedApiControl(GetApiaccesscontrolPrivilegedApiControlArgs.builder()
                .privilegedApiControlId(testPrivilegedApiControlOciApiaccesscontrolPrivilegedApiControl.id())
                .build());
    
        }
    }
    
    variables:
      testPrivilegedApiControl:
        fn::invoke:
          function: oci:oci:getApiaccesscontrolPrivilegedApiControl
          arguments:
            privilegedApiControlId: ${testPrivilegedApiControlOciApiaccesscontrolPrivilegedApiControl.id}
    

    Using getApiaccesscontrolPrivilegedApiControl

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getApiaccesscontrolPrivilegedApiControl(args: GetApiaccesscontrolPrivilegedApiControlArgs, opts?: InvokeOptions): Promise<GetApiaccesscontrolPrivilegedApiControlResult>
    function getApiaccesscontrolPrivilegedApiControlOutput(args: GetApiaccesscontrolPrivilegedApiControlOutputArgs, opts?: InvokeOptions): Output<GetApiaccesscontrolPrivilegedApiControlResult>
    def get_apiaccesscontrol_privileged_api_control(privileged_api_control_id: Optional[str] = None,
                                                    opts: Optional[InvokeOptions] = None) -> GetApiaccesscontrolPrivilegedApiControlResult
    def get_apiaccesscontrol_privileged_api_control_output(privileged_api_control_id: Optional[pulumi.Input[str]] = None,
                                                    opts: Optional[InvokeOptions] = None) -> Output[GetApiaccesscontrolPrivilegedApiControlResult]
    func LookupApiaccesscontrolPrivilegedApiControl(ctx *Context, args *LookupApiaccesscontrolPrivilegedApiControlArgs, opts ...InvokeOption) (*LookupApiaccesscontrolPrivilegedApiControlResult, error)
    func LookupApiaccesscontrolPrivilegedApiControlOutput(ctx *Context, args *LookupApiaccesscontrolPrivilegedApiControlOutputArgs, opts ...InvokeOption) LookupApiaccesscontrolPrivilegedApiControlResultOutput

    > Note: This function is named LookupApiaccesscontrolPrivilegedApiControl in the Go SDK.

    public static class GetApiaccesscontrolPrivilegedApiControl 
    {
        public static Task<GetApiaccesscontrolPrivilegedApiControlResult> InvokeAsync(GetApiaccesscontrolPrivilegedApiControlArgs args, InvokeOptions? opts = null)
        public static Output<GetApiaccesscontrolPrivilegedApiControlResult> Invoke(GetApiaccesscontrolPrivilegedApiControlInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetApiaccesscontrolPrivilegedApiControlResult> getApiaccesscontrolPrivilegedApiControl(GetApiaccesscontrolPrivilegedApiControlArgs args, InvokeOptions options)
    public static Output<GetApiaccesscontrolPrivilegedApiControlResult> getApiaccesscontrolPrivilegedApiControl(GetApiaccesscontrolPrivilegedApiControlArgs args, InvokeOptions options)
    
    fn::invoke:
      function: oci:oci/getApiaccesscontrolPrivilegedApiControl:getApiaccesscontrolPrivilegedApiControl
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PrivilegedApiControlId string
    The OCID of the PrivilegedApiControl.
    PrivilegedApiControlId string
    The OCID of the PrivilegedApiControl.
    privilegedApiControlId String
    The OCID of the PrivilegedApiControl.
    privilegedApiControlId string
    The OCID of the PrivilegedApiControl.
    privileged_api_control_id str
    The OCID of the PrivilegedApiControl.
    privilegedApiControlId String
    The OCID of the PrivilegedApiControl.

    getApiaccesscontrolPrivilegedApiControl Result

    The following output properties are available:

    ApproverGroupIdLists 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 string
    The OCID of the compartment.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    Description of privilegedApi control.
    DisplayName string
    Name of the privilegedApi control. The name must be unique.
    FreeformTags 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 string
    The OCID of the PrivilegedApiControl.
    LifecycleDetails 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.
    NotificationTopicId string
    The OCID of the Oracle Cloud Infrastructure Notification topic to publish messages related to this Privileged Api Control.
    NumberOfApprovers int
    Number of approvers required to approve an privilegedApi request.
    PrivilegedApiControlId string
    PrivilegedOperationLists List<GetApiaccesscontrolPrivilegedApiControlPrivilegedOperationList>
    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 string
    resourceType for which the PrivilegedApiControl is applicable
    Resources List<string>
    contains Resource details
    State string
    The current state of the PrivilegedApiControl.
    StateDetails 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 Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeDeleted string
    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 string
    The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    ApproverGroupIdLists []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 string
    The OCID of the compartment.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    Description of privilegedApi control.
    DisplayName string
    Name of the privilegedApi control. The name must be unique.
    FreeformTags map[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 string
    The OCID of the PrivilegedApiControl.
    LifecycleDetails 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.
    NotificationTopicId string
    The OCID of the Oracle Cloud Infrastructure Notification topic to publish messages related to this Privileged Api Control.
    NumberOfApprovers int
    Number of approvers required to approve an privilegedApi request.
    PrivilegedApiControlId string
    PrivilegedOperationLists []GetApiaccesscontrolPrivilegedApiControlPrivilegedOperationList
    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 string
    resourceType for which the PrivilegedApiControl is applicable
    Resources []string
    contains Resource details
    State string
    The current state of the PrivilegedApiControl.
    StateDetails 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 map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeDeleted string
    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 string
    The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    approverGroupIdLists 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 String
    The OCID of the compartment.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    Description of privilegedApi control.
    displayName String
    Name of the privilegedApi control. The name must be unique.
    freeformTags Map<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 String
    The OCID of the PrivilegedApiControl.
    lifecycleDetails 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.
    notificationTopicId String
    The OCID of the Oracle Cloud Infrastructure Notification topic to publish messages related to this Privileged Api Control.
    numberOfApprovers Integer
    Number of approvers required to approve an privilegedApi request.
    privilegedApiControlId String
    privilegedOperationLists List<GetApiaccesscontrolPrivilegedApiControlPrivilegedOperationList>
    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 String
    resourceType for which the PrivilegedApiControl is applicable
    resources List<String>
    contains Resource details
    state String
    The current state of the PrivilegedApiControl.
    stateDetails 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 Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeDeleted String
    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 String
    The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    approverGroupIdLists 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 string
    The OCID of the compartment.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    Description of privilegedApi control.
    displayName string
    Name of the privilegedApi control. The name must be unique.
    freeformTags {[key: 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 string
    The OCID of the PrivilegedApiControl.
    lifecycleDetails 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.
    notificationTopicId string
    The OCID of the Oracle Cloud Infrastructure Notification topic to publish messages related to this Privileged Api Control.
    numberOfApprovers number
    Number of approvers required to approve an privilegedApi request.
    privilegedApiControlId string
    privilegedOperationLists GetApiaccesscontrolPrivilegedApiControlPrivilegedOperationList[]
    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 string
    resourceType for which the PrivilegedApiControl is applicable
    resources string[]
    contains Resource details
    state string
    The current state of the PrivilegedApiControl.
    stateDetails 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 {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeDeleted string
    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 string
    The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    approver_group_id_lists Sequence[str]
    List of IAM user group ids who can approve an privilegedApi request associated with a target resource under the governance of this operator control.
    compartment_id str
    The OCID of the compartment.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    Description of privilegedApi control.
    display_name str
    Name of the privilegedApi control. The name must be unique.
    freeform_tags Mapping[str, str]
    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 str
    The OCID of the PrivilegedApiControl.
    lifecycle_details str
    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.
    notification_topic_id str
    The OCID of the Oracle Cloud Infrastructure Notification topic to publish messages related to this Privileged Api Control.
    number_of_approvers int
    Number of approvers required to approve an privilegedApi request.
    privileged_api_control_id str
    privileged_operation_lists Sequence[GetApiaccesscontrolPrivilegedApiControlPrivilegedOperationList]
    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.
    resource_type str
    resourceType for which the PrivilegedApiControl is applicable
    resources Sequence[str]
    contains Resource details
    state str
    The current state of the PrivilegedApiControl.
    state_details str
    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.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_deleted str
    The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    approverGroupIdLists 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 String
    The OCID of the compartment.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    Description of privilegedApi control.
    displayName String
    Name of the privilegedApi control. The name must be unique.
    freeformTags Map<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 String
    The OCID of the PrivilegedApiControl.
    lifecycleDetails 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.
    notificationTopicId String
    The OCID of the Oracle Cloud Infrastructure Notification topic to publish messages related to this Privileged Api Control.
    numberOfApprovers Number
    Number of approvers required to approve an privilegedApi request.
    privilegedApiControlId String
    privilegedOperationLists List<Property Map>
    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 String
    resourceType for which the PrivilegedApiControl is applicable
    resources List<String>
    contains Resource details
    state String
    The current state of the PrivilegedApiControl.
    stateDetails 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 Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeDeleted String
    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 String
    The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

    Supporting Types

    GetApiaccesscontrolPrivilegedApiControlPrivilegedOperationList

    ApiName string
    name of the api which needs to be protected.
    AttributeNames List<string>
    list of attributes belonging to the above api which needs to be protected.
    EntityType string
    type of the entity which needs to be protected.
    ApiName string
    name of the api which needs to be protected.
    AttributeNames []string
    list of attributes belonging to the above api which needs to be protected.
    EntityType string
    type of the entity which needs to be protected.
    apiName String
    name of the api which needs to be protected.
    attributeNames List<String>
    list of attributes belonging to the above api which needs to be protected.
    entityType String
    type of the entity which needs to be protected.
    apiName string
    name of the api which needs to be protected.
    attributeNames string[]
    list of attributes belonging to the above api which needs to be protected.
    entityType string
    type of the entity which needs to be protected.
    api_name str
    name of the api which needs to be protected.
    attribute_names Sequence[str]
    list of attributes belonging to the above api which needs to be protected.
    entity_type str
    type of the entity which needs to be protected.
    apiName String
    name of the api which needs to be protected.
    attributeNames List<String>
    list of attributes belonging to the above api which needs to be protected.
    entityType String
    type of the entity which needs to be protected.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v3.16.0 published on Wednesday, Jan 28, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate