1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. GpgKey
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

    A GPGKey object on Files.com is used to securely store both the private and public keys associated with a GPG (GNU Privacy Guard) encryption key pair. This object enables the encryption and decryption of data using GPG, allowing you to protect sensitive information.

    The private key is kept confidential and is used for decrypting data or signing messages to prove authenticity, while the public key is used to encrypt messages that only the owner of the private key can decrypt.

    By storing both keys together in a GPGKey object, Files.com makes it easier to understand encryption operations, ensuring secure and efficient handling of encrypted data within the platform.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const exampleGpgKey = new filescom.GpgKey("example_gpg_key", {
        userId: 1,
        partnerId: 1,
        name: "key name",
        workspaceId: 0,
        generateExpiresAt: "2025-06-19 12:00:00",
        generateKeypair: false,
        generateFullName: "John Doe",
        generateEmail: "jdoe@example.com",
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_gpg_key = filescom.GpgKey("example_gpg_key",
        user_id=1,
        partner_id=1,
        name="key name",
        workspace_id=0,
        generate_expires_at="2025-06-19 12:00:00",
        generate_keypair=False,
        generate_full_name="John Doe",
        generate_email="jdoe@example.com")
    
    package main
    
    import (
    	"github.com/jschady/pulumi-filescom/sdk/go/filescom"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := filescom.NewGpgKey(ctx, "example_gpg_key", &filescom.GpgKeyArgs{
    			UserId:            pulumi.Int(1),
    			PartnerId:         pulumi.Int(1),
    			Name:              pulumi.String("key name"),
    			WorkspaceId:       pulumi.Int(0),
    			GenerateExpiresAt: pulumi.String("2025-06-19 12:00:00"),
    			GenerateKeypair:   pulumi.Bool(false),
    			GenerateFullName:  pulumi.String("John Doe"),
    			GenerateEmail:     pulumi.String("jdoe@example.com"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Filescom = Jschady.Filescom;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleGpgKey = new Filescom.GpgKey("example_gpg_key", new()
        {
            UserId = 1,
            PartnerId = 1,
            Name = "key name",
            WorkspaceId = 0,
            GenerateExpiresAt = "2025-06-19 12:00:00",
            GenerateKeypair = false,
            GenerateFullName = "John Doe",
            GenerateEmail = "jdoe@example.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.GpgKey;
    import com.pulumi.filescom.GpgKeyArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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) {
            var exampleGpgKey = new GpgKey("exampleGpgKey", GpgKeyArgs.builder()
                .userId(1)
                .partnerId(1)
                .name("key name")
                .workspaceId(0)
                .generateExpiresAt("2025-06-19 12:00:00")
                .generateKeypair(false)
                .generateFullName("John Doe")
                .generateEmail("jdoe@example.com")
                .build());
    
        }
    }
    
    resources:
      exampleGpgKey:
        type: filescom:GpgKey
        name: example_gpg_key
        properties:
          userId: 1
          partnerId: 1
          name: key name
          workspaceId: 0
          generateExpiresAt: 2025-06-19 12:00:00
          generateKeypair: false
          generateFullName: John Doe
          generateEmail: jdoe@example.com
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    resource "filescom_gpgkey" "example_gpg_key" {
      user_id             = 1
      partner_id          = 1
      name                = "key name"
      workspace_id        = 0
      generate_expires_at = "2025-06-19 12:00:00"
      generate_keypair    = false
      generate_full_name  = "John Doe"
      generate_email      = "jdoe@example.com"
    }
    

    Create GpgKey Resource

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

    Constructor syntax

    new GpgKey(name: string, args?: GpgKeyArgs, opts?: CustomResourceOptions);
    @overload
    def GpgKey(resource_name: str,
               args: Optional[GpgKeyArgs] = None,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def GpgKey(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               generate_email: Optional[str] = None,
               generate_expires_at: Optional[str] = None,
               generate_full_name: Optional[str] = None,
               generate_keypair: Optional[bool] = None,
               name: Optional[str] = None,
               partner_id: Optional[int] = None,
               private_key: Optional[str] = None,
               private_key_password: Optional[str] = None,
               public_key: Optional[str] = None,
               user_id: Optional[int] = None,
               workspace_id: Optional[int] = None)
    func NewGpgKey(ctx *Context, name string, args *GpgKeyArgs, opts ...ResourceOption) (*GpgKey, error)
    public GpgKey(string name, GpgKeyArgs? args = null, CustomResourceOptions? opts = null)
    public GpgKey(String name, GpgKeyArgs args)
    public GpgKey(String name, GpgKeyArgs args, CustomResourceOptions options)
    
    type: filescom:GpgKey
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "filescom_gpg_key" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args GpgKeyArgs
    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 GpgKeyArgs
    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 GpgKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GpgKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GpgKeyArgs
    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 gpgKeyResource = new Filescom.GpgKey("gpgKeyResource", new()
    {
        GenerateEmail = "string",
        GenerateExpiresAt = "string",
        GenerateFullName = "string",
        GenerateKeypair = false,
        Name = "string",
        PartnerId = 0,
        PrivateKey = "string",
        PrivateKeyPassword = "string",
        PublicKey = "string",
        UserId = 0,
        WorkspaceId = 0,
    });
    
    example, err := filescom.NewGpgKey(ctx, "gpgKeyResource", &filescom.GpgKeyArgs{
    	GenerateEmail:      pulumi.String("string"),
    	GenerateExpiresAt:  pulumi.String("string"),
    	GenerateFullName:   pulumi.String("string"),
    	GenerateKeypair:    pulumi.Bool(false),
    	Name:               pulumi.String("string"),
    	PartnerId:          pulumi.Int(0),
    	PrivateKey:         pulumi.String("string"),
    	PrivateKeyPassword: pulumi.String("string"),
    	PublicKey:          pulumi.String("string"),
    	UserId:             pulumi.Int(0),
    	WorkspaceId:        pulumi.Int(0),
    })
    
    resource "filescom_gpg_key" "gpgKeyResource" {
      lifecycle {
        create_before_destroy = true
      }
      generate_email       = "string"
      generate_expires_at  = "string"
      generate_full_name   = "string"
      generate_keypair     = false
      name                 = "string"
      partner_id           = 0
      private_key          = "string"
      private_key_password = "string"
      public_key           = "string"
      user_id              = 0
      workspace_id         = 0
    }
    
    var gpgKeyResource = new GpgKey("gpgKeyResource", GpgKeyArgs.builder()
        .generateEmail("string")
        .generateExpiresAt("string")
        .generateFullName("string")
        .generateKeypair(false)
        .name("string")
        .partnerId(0)
        .privateKey("string")
        .privateKeyPassword("string")
        .publicKey("string")
        .userId(0)
        .workspaceId(0)
        .build());
    
    gpg_key_resource = filescom.GpgKey("gpgKeyResource",
        generate_email="string",
        generate_expires_at="string",
        generate_full_name="string",
        generate_keypair=False,
        name="string",
        partner_id=0,
        private_key="string",
        private_key_password="string",
        public_key="string",
        user_id=0,
        workspace_id=0)
    
    const gpgKeyResource = new filescom.GpgKey("gpgKeyResource", {
        generateEmail: "string",
        generateExpiresAt: "string",
        generateFullName: "string",
        generateKeypair: false,
        name: "string",
        partnerId: 0,
        privateKey: "string",
        privateKeyPassword: "string",
        publicKey: "string",
        userId: 0,
        workspaceId: 0,
    });
    
    type: filescom:GpgKey
    properties:
        generateEmail: string
        generateExpiresAt: string
        generateFullName: string
        generateKeypair: false
        name: string
        partnerId: 0
        privateKey: string
        privateKeyPassword: string
        publicKey: string
        userId: 0
        workspaceId: 0
    

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

    GenerateEmail string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Email address of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GenerateExpiresAt string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Expiration date of the key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GenerateFullName string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Full name of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GenerateKeypair bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, generate a new GPG key pair. Can not be used with publicKey/privateKey
    Name string
    GPG key name.
    PartnerId int
    Partner ID who owns this GPG Key, if applicable.
    PrivateKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key
    PrivateKeyPassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key password
    PublicKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG public key
    UserId int
    User ID who owns this GPG Key, if applicable.
    WorkspaceId int
    Workspace ID (0 for default workspace).
    GenerateEmail string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Email address of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GenerateExpiresAt string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Expiration date of the key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GenerateFullName string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Full name of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GenerateKeypair bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, generate a new GPG key pair. Can not be used with publicKey/privateKey
    Name string
    GPG key name.
    PartnerId int
    Partner ID who owns this GPG Key, if applicable.
    PrivateKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key
    PrivateKeyPassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key password
    PublicKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG public key
    UserId int
    User ID who owns this GPG Key, if applicable.
    WorkspaceId int
    Workspace ID (0 for default workspace).
    generate_email string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Email address of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generate_expires_at string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Expiration date of the key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generate_full_name string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Full name of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generate_keypair bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, generate a new GPG key pair. Can not be used with publicKey/privateKey
    name string
    GPG key name.
    partner_id number
    Partner ID who owns this GPG Key, if applicable.
    private_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key
    private_key_password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key password
    public_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG public key
    user_id number
    User ID who owns this GPG Key, if applicable.
    workspace_id number
    Workspace ID (0 for default workspace).
    generateEmail String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Email address of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateExpiresAt String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Expiration date of the key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateFullName String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Full name of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateKeypair Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, generate a new GPG key pair. Can not be used with publicKey/privateKey
    name String
    GPG key name.
    partnerId Integer
    Partner ID who owns this GPG Key, if applicable.
    privateKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key
    privateKeyPassword String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key password
    publicKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG public key
    userId Integer
    User ID who owns this GPG Key, if applicable.
    workspaceId Integer
    Workspace ID (0 for default workspace).
    generateEmail string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Email address of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateExpiresAt string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Expiration date of the key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateFullName string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Full name of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateKeypair boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, generate a new GPG key pair. Can not be used with publicKey/privateKey
    name string
    GPG key name.
    partnerId number
    Partner ID who owns this GPG Key, if applicable.
    privateKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key
    privateKeyPassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key password
    publicKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG public key
    userId number
    User ID who owns this GPG Key, if applicable.
    workspaceId number
    Workspace ID (0 for default workspace).
    generate_email str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Email address of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generate_expires_at str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Expiration date of the key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generate_full_name str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Full name of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generate_keypair bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, generate a new GPG key pair. Can not be used with publicKey/privateKey
    name str
    GPG key name.
    partner_id int
    Partner ID who owns this GPG Key, if applicable.
    private_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key
    private_key_password str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key password
    public_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG public key
    user_id int
    User ID who owns this GPG Key, if applicable.
    workspace_id int
    Workspace ID (0 for default workspace).
    generateEmail String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Email address of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateExpiresAt String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Expiration date of the key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateFullName String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Full name of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateKeypair Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, generate a new GPG key pair. Can not be used with publicKey/privateKey
    name String
    GPG key name.
    partnerId Number
    Partner ID who owns this GPG Key, if applicable.
    privateKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key
    privateKeyPassword String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key password
    publicKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG public key
    userId Number
    User ID who owns this GPG Key, if applicable.
    workspaceId Number
    Workspace ID (0 for default workspace).

    Outputs

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

    ExpiresAt string
    GPG key expiration date.
    GeneratedPrivateKey string
    GPG private key.
    GeneratedPublicKey string
    GPG public key
    Id string
    The provider-assigned unique ID for this managed resource.
    PartnerName string
    Name of the Partner who owns this GPG Key, if applicable.
    PrivateKeyMd5 string
    MD5 hash of the GPG private key.
    PrivateKeyPasswordMd5 string
    GPG private key password. Only required for password protected keys.
    PublicKeyMd5 string
    MD5 hash of the GPG public key
    ExpiresAt string
    GPG key expiration date.
    GeneratedPrivateKey string
    GPG private key.
    GeneratedPublicKey string
    GPG public key
    Id string
    The provider-assigned unique ID for this managed resource.
    PartnerName string
    Name of the Partner who owns this GPG Key, if applicable.
    PrivateKeyMd5 string
    MD5 hash of the GPG private key.
    PrivateKeyPasswordMd5 string
    GPG private key password. Only required for password protected keys.
    PublicKeyMd5 string
    MD5 hash of the GPG public key
    expires_at string
    GPG key expiration date.
    generated_private_key string
    GPG private key.
    generated_public_key string
    GPG public key
    id string
    The provider-assigned unique ID for this managed resource.
    partner_name string
    Name of the Partner who owns this GPG Key, if applicable.
    private_key_md5 string
    MD5 hash of the GPG private key.
    private_key_password_md5 string
    GPG private key password. Only required for password protected keys.
    public_key_md5 string
    MD5 hash of the GPG public key
    expiresAt String
    GPG key expiration date.
    generatedPrivateKey String
    GPG private key.
    generatedPublicKey String
    GPG public key
    id String
    The provider-assigned unique ID for this managed resource.
    partnerName String
    Name of the Partner who owns this GPG Key, if applicable.
    privateKeyMd5 String
    MD5 hash of the GPG private key.
    privateKeyPasswordMd5 String
    GPG private key password. Only required for password protected keys.
    publicKeyMd5 String
    MD5 hash of the GPG public key
    expiresAt string
    GPG key expiration date.
    generatedPrivateKey string
    GPG private key.
    generatedPublicKey string
    GPG public key
    id string
    The provider-assigned unique ID for this managed resource.
    partnerName string
    Name of the Partner who owns this GPG Key, if applicable.
    privateKeyMd5 string
    MD5 hash of the GPG private key.
    privateKeyPasswordMd5 string
    GPG private key password. Only required for password protected keys.
    publicKeyMd5 string
    MD5 hash of the GPG public key
    expires_at str
    GPG key expiration date.
    generated_private_key str
    GPG private key.
    generated_public_key str
    GPG public key
    id str
    The provider-assigned unique ID for this managed resource.
    partner_name str
    Name of the Partner who owns this GPG Key, if applicable.
    private_key_md5 str
    MD5 hash of the GPG private key.
    private_key_password_md5 str
    GPG private key password. Only required for password protected keys.
    public_key_md5 str
    MD5 hash of the GPG public key
    expiresAt String
    GPG key expiration date.
    generatedPrivateKey String
    GPG private key.
    generatedPublicKey String
    GPG public key
    id String
    The provider-assigned unique ID for this managed resource.
    partnerName String
    Name of the Partner who owns this GPG Key, if applicable.
    privateKeyMd5 String
    MD5 hash of the GPG private key.
    privateKeyPasswordMd5 String
    GPG private key password. Only required for password protected keys.
    publicKeyMd5 String
    MD5 hash of the GPG public key

    Look up Existing GpgKey Resource

    Get an existing GpgKey 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?: GpgKeyState, opts?: CustomResourceOptions): GpgKey
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            expires_at: Optional[str] = None,
            generate_email: Optional[str] = None,
            generate_expires_at: Optional[str] = None,
            generate_full_name: Optional[str] = None,
            generate_keypair: Optional[bool] = None,
            generated_private_key: Optional[str] = None,
            generated_public_key: Optional[str] = None,
            name: Optional[str] = None,
            partner_id: Optional[int] = None,
            partner_name: Optional[str] = None,
            private_key: Optional[str] = None,
            private_key_md5: Optional[str] = None,
            private_key_password: Optional[str] = None,
            private_key_password_md5: Optional[str] = None,
            public_key: Optional[str] = None,
            public_key_md5: Optional[str] = None,
            user_id: Optional[int] = None,
            workspace_id: Optional[int] = None) -> GpgKey
    func GetGpgKey(ctx *Context, name string, id IDInput, state *GpgKeyState, opts ...ResourceOption) (*GpgKey, error)
    public static GpgKey Get(string name, Input<string> id, GpgKeyState? state, CustomResourceOptions? opts = null)
    public static GpgKey get(String name, Output<String> id, GpgKeyState state, CustomResourceOptions options)
    resources:  _:    type: filescom:GpgKey    get:      id: ${id}
    import {
      to = filescom_gpg_key.example
      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:
    ExpiresAt string
    GPG key expiration date.
    GenerateEmail string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Email address of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GenerateExpiresAt string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Expiration date of the key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GenerateFullName string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Full name of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GenerateKeypair bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, generate a new GPG key pair. Can not be used with publicKey/privateKey
    GeneratedPrivateKey string
    GPG private key.
    GeneratedPublicKey string
    GPG public key
    Name string
    GPG key name.
    PartnerId int
    Partner ID who owns this GPG Key, if applicable.
    PartnerName string
    Name of the Partner who owns this GPG Key, if applicable.
    PrivateKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key
    PrivateKeyMd5 string
    MD5 hash of the GPG private key.
    PrivateKeyPassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key password
    PrivateKeyPasswordMd5 string
    GPG private key password. Only required for password protected keys.
    PublicKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG public key
    PublicKeyMd5 string
    MD5 hash of the GPG public key
    UserId int
    User ID who owns this GPG Key, if applicable.
    WorkspaceId int
    Workspace ID (0 for default workspace).
    ExpiresAt string
    GPG key expiration date.
    GenerateEmail string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Email address of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GenerateExpiresAt string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Expiration date of the key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GenerateFullName string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Full name of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GenerateKeypair bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, generate a new GPG key pair. Can not be used with publicKey/privateKey
    GeneratedPrivateKey string
    GPG private key.
    GeneratedPublicKey string
    GPG public key
    Name string
    GPG key name.
    PartnerId int
    Partner ID who owns this GPG Key, if applicable.
    PartnerName string
    Name of the Partner who owns this GPG Key, if applicable.
    PrivateKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key
    PrivateKeyMd5 string
    MD5 hash of the GPG private key.
    PrivateKeyPassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key password
    PrivateKeyPasswordMd5 string
    GPG private key password. Only required for password protected keys.
    PublicKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG public key
    PublicKeyMd5 string
    MD5 hash of the GPG public key
    UserId int
    User ID who owns this GPG Key, if applicable.
    WorkspaceId int
    Workspace ID (0 for default workspace).
    expires_at string
    GPG key expiration date.
    generate_email string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Email address of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generate_expires_at string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Expiration date of the key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generate_full_name string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Full name of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generate_keypair bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, generate a new GPG key pair. Can not be used with publicKey/privateKey
    generated_private_key string
    GPG private key.
    generated_public_key string
    GPG public key
    name string
    GPG key name.
    partner_id number
    Partner ID who owns this GPG Key, if applicable.
    partner_name string
    Name of the Partner who owns this GPG Key, if applicable.
    private_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key
    private_key_md5 string
    MD5 hash of the GPG private key.
    private_key_password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key password
    private_key_password_md5 string
    GPG private key password. Only required for password protected keys.
    public_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG public key
    public_key_md5 string
    MD5 hash of the GPG public key
    user_id number
    User ID who owns this GPG Key, if applicable.
    workspace_id number
    Workspace ID (0 for default workspace).
    expiresAt String
    GPG key expiration date.
    generateEmail String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Email address of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateExpiresAt String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Expiration date of the key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateFullName String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Full name of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateKeypair Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, generate a new GPG key pair. Can not be used with publicKey/privateKey
    generatedPrivateKey String
    GPG private key.
    generatedPublicKey String
    GPG public key
    name String
    GPG key name.
    partnerId Integer
    Partner ID who owns this GPG Key, if applicable.
    partnerName String
    Name of the Partner who owns this GPG Key, if applicable.
    privateKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key
    privateKeyMd5 String
    MD5 hash of the GPG private key.
    privateKeyPassword String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key password
    privateKeyPasswordMd5 String
    GPG private key password. Only required for password protected keys.
    publicKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG public key
    publicKeyMd5 String
    MD5 hash of the GPG public key
    userId Integer
    User ID who owns this GPG Key, if applicable.
    workspaceId Integer
    Workspace ID (0 for default workspace).
    expiresAt string
    GPG key expiration date.
    generateEmail string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Email address of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateExpiresAt string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Expiration date of the key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateFullName string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Full name of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateKeypair boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, generate a new GPG key pair. Can not be used with publicKey/privateKey
    generatedPrivateKey string
    GPG private key.
    generatedPublicKey string
    GPG public key
    name string
    GPG key name.
    partnerId number
    Partner ID who owns this GPG Key, if applicable.
    partnerName string
    Name of the Partner who owns this GPG Key, if applicable.
    privateKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key
    privateKeyMd5 string
    MD5 hash of the GPG private key.
    privateKeyPassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key password
    privateKeyPasswordMd5 string
    GPG private key password. Only required for password protected keys.
    publicKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG public key
    publicKeyMd5 string
    MD5 hash of the GPG public key
    userId number
    User ID who owns this GPG Key, if applicable.
    workspaceId number
    Workspace ID (0 for default workspace).
    expires_at str
    GPG key expiration date.
    generate_email str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Email address of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generate_expires_at str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Expiration date of the key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generate_full_name str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Full name of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generate_keypair bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, generate a new GPG key pair. Can not be used with publicKey/privateKey
    generated_private_key str
    GPG private key.
    generated_public_key str
    GPG public key
    name str
    GPG key name.
    partner_id int
    Partner ID who owns this GPG Key, if applicable.
    partner_name str
    Name of the Partner who owns this GPG Key, if applicable.
    private_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key
    private_key_md5 str
    MD5 hash of the GPG private key.
    private_key_password str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key password
    private_key_password_md5 str
    GPG private key password. Only required for password protected keys.
    public_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG public key
    public_key_md5 str
    MD5 hash of the GPG public key
    user_id int
    User ID who owns this GPG Key, if applicable.
    workspace_id int
    Workspace ID (0 for default workspace).
    expiresAt String
    GPG key expiration date.
    generateEmail String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Email address of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateExpiresAt String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Expiration date of the key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateFullName String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Full name of the key owner. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generateKeypair Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, generate a new GPG key pair. Can not be used with publicKey/privateKey
    generatedPrivateKey String
    GPG private key.
    generatedPublicKey String
    GPG public key
    name String
    GPG key name.
    partnerId Number
    Partner ID who owns this GPG Key, if applicable.
    partnerName String
    Name of the Partner who owns this GPG Key, if applicable.
    privateKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key
    privateKeyMd5 String
    MD5 hash of the GPG private key.
    privateKeyPassword String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG private key password
    privateKeyPasswordMd5 String
    GPG private key password. Only required for password protected keys.
    publicKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The GPG public key
    publicKeyMd5 String
    MD5 hash of the GPG public key
    userId Number
    User ID who owns this GPG Key, if applicable.
    workspaceId Number
    Workspace ID (0 for default workspace).

    Import

    The pulumi import command can be used, for example:

    Gpg Keys can be imported by specifying the id.

    $ pulumi import filescom:index/gpgKey:GpgKey example_gpg_key 1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    filescom jschady/pulumi-filescom
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial