1. Packages
  2. Packages
  3. Pulumi Cloud (Pulumi Service provider)
  4. API Docs
  5. api
  6. api/esc
  7. OpenEnvironmentRequest

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi
pulumiservice logo

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi

    Creates an open request for a Pulumi ESC environment that has gated opens enabled. When an environment has open gates configured, opening the environment requires an approval workflow. This endpoint initiates that process by creating an open request, and also creates corresponding open requests for each imported environment that has open gates. Requires the Approvals feature to be enabled for the organization. Returns 400 if the environment does not have gated opens.

    Create OpenEnvironmentRequest Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OpenEnvironmentRequest(name: string, args: OpenEnvironmentRequestArgs, opts?: CustomResourceOptions);
    @overload
    def OpenEnvironmentRequest(resource_name: str,
                               args: OpenEnvironmentRequestArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def OpenEnvironmentRequest(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               access_duration_seconds: Optional[int] = None,
                               env_name: Optional[str] = None,
                               grant_expiration_seconds: Optional[int] = None,
                               org_name: Optional[str] = None,
                               project_name: Optional[str] = None,
                               change_request_id: Optional[str] = None)
    func NewOpenEnvironmentRequest(ctx *Context, name string, args OpenEnvironmentRequestArgs, opts ...ResourceOption) (*OpenEnvironmentRequest, error)
    public OpenEnvironmentRequest(string name, OpenEnvironmentRequestArgs args, CustomResourceOptions? opts = null)
    public OpenEnvironmentRequest(String name, OpenEnvironmentRequestArgs args)
    public OpenEnvironmentRequest(String name, OpenEnvironmentRequestArgs args, CustomResourceOptions options)
    
    type: pulumiservice:api/esc:OpenEnvironmentRequest
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "pulumiservice_api_esc_openenvironmentrequest" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args OpenEnvironmentRequestArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OpenEnvironmentRequestArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OpenEnvironmentRequestArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OpenEnvironmentRequestArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OpenEnvironmentRequestArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var openEnvironmentRequestResource = new PulumiService.Api.Esc.OpenEnvironmentRequest("openEnvironmentRequestResource", new()
    {
        AccessDurationSeconds = 0,
        EnvName = "string",
        GrantExpirationSeconds = 0,
        OrgName = "string",
        ProjectName = "string",
        ChangeRequestId = "string",
    });
    
    example, err := esc.NewOpenEnvironmentRequest(ctx, "openEnvironmentRequestResource", &esc.OpenEnvironmentRequestArgs{
    	AccessDurationSeconds:  pulumi.Int(0),
    	EnvName:                pulumi.String("string"),
    	GrantExpirationSeconds: pulumi.Int(0),
    	OrgName:                pulumi.String("string"),
    	ProjectName:            pulumi.String("string"),
    	ChangeRequestId:        pulumi.String("string"),
    })
    
    resource "pulumiservice_api_esc_openenvironmentrequest" "openEnvironmentRequestResource" {
      access_duration_seconds  = 0
      env_name                 = "string"
      grant_expiration_seconds = 0
      org_name                 = "string"
      project_name             = "string"
      change_request_id        = "string"
    }
    
    var openEnvironmentRequestResource = new OpenEnvironmentRequest("openEnvironmentRequestResource", OpenEnvironmentRequestArgs.builder()
        .accessDurationSeconds(0)
        .envName("string")
        .grantExpirationSeconds(0)
        .orgName("string")
        .projectName("string")
        .changeRequestId("string")
        .build());
    
    open_environment_request_resource = pulumiservice.api.esc.OpenEnvironmentRequest("openEnvironmentRequestResource",
        access_duration_seconds=0,
        env_name="string",
        grant_expiration_seconds=0,
        org_name="string",
        project_name="string",
        change_request_id="string")
    
    const openEnvironmentRequestResource = new pulumiservice.api.esc.OpenEnvironmentRequest("openEnvironmentRequestResource", {
        accessDurationSeconds: 0,
        envName: "string",
        grantExpirationSeconds: 0,
        orgName: "string",
        projectName: "string",
        changeRequestId: "string",
    });
    
    type: pulumiservice:api/esc:OpenEnvironmentRequest
    properties:
        accessDurationSeconds: 0
        changeRequestId: string
        envName: string
        grantExpirationSeconds: 0
        orgName: string
        projectName: string
    

    OpenEnvironmentRequest Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OpenEnvironmentRequest resource accepts the following input properties:

    AccessDurationSeconds int
    Total duration that the resulting grant can be used to access the environment open endpoint (after first open)
    EnvName string
    The environment name
    GrantExpirationSeconds int
    Time from application of the request until the resulting grant expires
    OrgName string
    The organization name
    ProjectName string
    The project name
    ChangeRequestId string
    The change request ID
    AccessDurationSeconds int
    Total duration that the resulting grant can be used to access the environment open endpoint (after first open)
    EnvName string
    The environment name
    GrantExpirationSeconds int
    Time from application of the request until the resulting grant expires
    OrgName string
    The organization name
    ProjectName string
    The project name
    ChangeRequestId string
    The change request ID
    access_duration_seconds number
    Total duration that the resulting grant can be used to access the environment open endpoint (after first open)
    env_name string
    The environment name
    grant_expiration_seconds number
    Time from application of the request until the resulting grant expires
    org_name string
    The organization name
    project_name string
    The project name
    change_request_id string
    The change request ID
    accessDurationSeconds Integer
    Total duration that the resulting grant can be used to access the environment open endpoint (after first open)
    envName String
    The environment name
    grantExpirationSeconds Integer
    Time from application of the request until the resulting grant expires
    orgName String
    The organization name
    projectName String
    The project name
    changeRequestId String
    The change request ID
    accessDurationSeconds number
    Total duration that the resulting grant can be used to access the environment open endpoint (after first open)
    envName string
    The environment name
    grantExpirationSeconds number
    Time from application of the request until the resulting grant expires
    orgName string
    The organization name
    projectName string
    The project name
    changeRequestId string
    The change request ID
    access_duration_seconds int
    Total duration that the resulting grant can be used to access the environment open endpoint (after first open)
    env_name str
    The environment name
    grant_expiration_seconds int
    Time from application of the request until the resulting grant expires
    org_name str
    The organization name
    project_name str
    The project name
    change_request_id str
    The change request ID
    accessDurationSeconds Number
    Total duration that the resulting grant can be used to access the environment open endpoint (after first open)
    envName String
    The environment name
    grantExpirationSeconds Number
    Time from application of the request until the resulting grant expires
    orgName String
    The organization name
    projectName String
    The project name
    changeRequestId String
    The change request ID

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OpenEnvironmentRequest resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    pulumiservice pulumi/pulumi-pulumiservice
    License
    Apache-2.0
    pulumiservice logo

    This provider is currently in preview.

    Viewing docs for Pulumi Cloud v1.1.0
    published on Thursday, May 21, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial