1. Packages
  2. Port
  3. API Docs
  4. OrganizationSecret
Port v2.17.4 published on Wednesday, Dec 17, 2025 by port-labs
port logo
Port v2.17.4 published on Wednesday, Dec 17, 2025 by port-labs

    Organization secret resource

    Create OrganizationSecret Resource

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

    Constructor syntax

    new OrganizationSecret(name: string, args: OrganizationSecretArgs, opts?: CustomResourceOptions);
    @overload
    def OrganizationSecret(resource_name: str,
                           args: OrganizationSecretArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def OrganizationSecret(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           secret_name: Optional[str] = None,
                           secret_value: Optional[str] = None,
                           description: Optional[str] = None)
    func NewOrganizationSecret(ctx *Context, name string, args OrganizationSecretArgs, opts ...ResourceOption) (*OrganizationSecret, error)
    public OrganizationSecret(string name, OrganizationSecretArgs args, CustomResourceOptions? opts = null)
    public OrganizationSecret(String name, OrganizationSecretArgs args)
    public OrganizationSecret(String name, OrganizationSecretArgs args, CustomResourceOptions options)
    
    type: port:OrganizationSecret
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args OrganizationSecretArgs
    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 OrganizationSecretArgs
    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 OrganizationSecretArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationSecretArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationSecretArgs
    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 organizationSecretResource = new Port.OrganizationSecret("organizationSecretResource", new()
    {
        SecretName = "string",
        SecretValue = "string",
        Description = "string",
    });
    
    example, err := port.NewOrganizationSecret(ctx, "organizationSecretResource", &port.OrganizationSecretArgs{
    	SecretName:  pulumi.String("string"),
    	SecretValue: pulumi.String("string"),
    	Description: pulumi.String("string"),
    })
    
    var organizationSecretResource = new OrganizationSecret("organizationSecretResource", OrganizationSecretArgs.builder()
        .secretName("string")
        .secretValue("string")
        .description("string")
        .build());
    
    organization_secret_resource = port.OrganizationSecret("organizationSecretResource",
        secret_name="string",
        secret_value="string",
        description="string")
    
    const organizationSecretResource = new port.OrganizationSecret("organizationSecretResource", {
        secretName: "string",
        secretValue: "string",
        description: "string",
    });
    
    type: port:OrganizationSecret
    properties:
        description: string
        secretName: string
        secretValue: string
    

    OrganizationSecret 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 OrganizationSecret resource accepts the following input properties:

    SecretName string
    The name of the organization secret
    SecretValue string
    The value of the organization secret
    Description string
    The description of the organization secret
    SecretName string
    The name of the organization secret
    SecretValue string
    The value of the organization secret
    Description string
    The description of the organization secret
    secretName String
    The name of the organization secret
    secretValue String
    The value of the organization secret
    description String
    The description of the organization secret
    secretName string
    The name of the organization secret
    secretValue string
    The value of the organization secret
    description string
    The description of the organization secret
    secret_name str
    The name of the organization secret
    secret_value str
    The value of the organization secret
    description str
    The description of the organization secret
    secretName String
    The name of the organization secret
    secretValue String
    The value of the organization secret
    description String
    The description of the organization secret

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OrganizationSecret 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OrganizationSecret Resource

    Get an existing OrganizationSecret resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OrganizationSecretState, opts?: CustomResourceOptions): OrganizationSecret
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            secret_name: Optional[str] = None,
            secret_value: Optional[str] = None) -> OrganizationSecret
    func GetOrganizationSecret(ctx *Context, name string, id IDInput, state *OrganizationSecretState, opts ...ResourceOption) (*OrganizationSecret, error)
    public static OrganizationSecret Get(string name, Input<string> id, OrganizationSecretState? state, CustomResourceOptions? opts = null)
    public static OrganizationSecret get(String name, Output<String> id, OrganizationSecretState state, CustomResourceOptions options)
    resources:  _:    type: port:OrganizationSecret    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    The description of the organization secret
    SecretName string
    The name of the organization secret
    SecretValue string
    The value of the organization secret
    Description string
    The description of the organization secret
    SecretName string
    The name of the organization secret
    SecretValue string
    The value of the organization secret
    description String
    The description of the organization secret
    secretName String
    The name of the organization secret
    secretValue String
    The value of the organization secret
    description string
    The description of the organization secret
    secretName string
    The name of the organization secret
    secretValue string
    The value of the organization secret
    description str
    The description of the organization secret
    secret_name str
    The name of the organization secret
    secret_value str
    The value of the organization secret
    description String
    The description of the organization secret
    secretName String
    The name of the organization secret
    secretValue String
    The value of the organization secret

    Package Details

    Repository
    port port-labs/pulumi-port
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the port-labs Terraform Provider.
    port logo
    Port v2.17.4 published on Wednesday, Dec 17, 2025 by port-labs
      Meet Neo: Your AI Platform Teammate