1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. PublicKey
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 PublicKey is used to authenticate to Files.com via SFTP (SSH File Transfer Protocol). This method of authentication allows users to use their private key (which is never shared with Files.com) to authenticate themselves against the PublicKey stored on Files.com.

    When a user configures their PublicKey, it allows them to bypass traditional password-based authentication, leveraging the security of key-based authentication instead.

    Note that Files.com’s SSH support is limited to file operations only. While users can securely transfer files and manage their data via SFTP, they do not have access to a full shell environment for executing arbitrary commands.

    When generating new SSH keys, here are the available options: Files.com supports multiple SSH key algorithms: RSA (default 4096 bits, range 1024-4096 in 8-bit increments), DSA (1024 bits only), Ed25519 (256 bits), and ECDSA (256, 384, or 521 bits). When generating keys, the system uses these default lengths unless a specific length is specified.

    Files.com also supports importing additional key types that cannot be generated: security key types (sk-ecdsa-sha2-nistp256, sk-ssh-ed25519). RSA keys up to 8192 bits are also supported for import.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const examplePublicKey = new filescom.PublicKey("example_public_key", {
        userId: 1,
        title: "My Main Key",
        generateKeypair: false,
        generatePrivateKeyPassword: "[your private key password]",
        generateAlgorithm: "rsa",
        generateLength: 4096,
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_public_key = filescom.PublicKey("example_public_key",
        user_id=1,
        title="My Main Key",
        generate_keypair=False,
        generate_private_key_password="[your private key password]",
        generate_algorithm="rsa",
        generate_length=4096)
    
    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.NewPublicKey(ctx, "example_public_key", &filescom.PublicKeyArgs{
    			UserId:                     pulumi.Int(1),
    			Title:                      pulumi.String("My Main Key"),
    			GenerateKeypair:            pulumi.Bool(false),
    			GeneratePrivateKeyPassword: pulumi.String("[your private key password]"),
    			GenerateAlgorithm:          pulumi.String("rsa"),
    			GenerateLength:             pulumi.Int(4096),
    		})
    		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 examplePublicKey = new Filescom.PublicKey("example_public_key", new()
        {
            UserId = 1,
            Title = "My Main Key",
            GenerateKeypair = false,
            GeneratePrivateKeyPassword = "[your private key password]",
            GenerateAlgorithm = "rsa",
            GenerateLength = 4096,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.PublicKey;
    import com.pulumi.filescom.PublicKeyArgs;
    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 examplePublicKey = new PublicKey("examplePublicKey", PublicKeyArgs.builder()
                .userId(1)
                .title("My Main Key")
                .generateKeypair(false)
                .generatePrivateKeyPassword("[your private key password]")
                .generateAlgorithm("rsa")
                .generateLength(4096)
                .build());
    
        }
    }
    
    resources:
      examplePublicKey:
        type: filescom:PublicKey
        name: example_public_key
        properties:
          userId: 1
          title: My Main Key
          generateKeypair: false
          generatePrivateKeyPassword: '[your private key password]'
          generateAlgorithm: rsa
          generateLength: 4096
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    resource "filescom_publickey" "example_public_key" {
      user_id                       = 1
      title                         = "My Main Key"
      generate_keypair              = false
      generate_private_key_password = "[your private key password]"
      generate_algorithm            = "rsa"
      generate_length               = 4096
    }
    

    Create PublicKey Resource

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

    Constructor syntax

    new PublicKey(name: string, args: PublicKeyArgs, opts?: CustomResourceOptions);
    @overload
    def PublicKey(resource_name: str,
                  args: PublicKeyArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def PublicKey(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  title: Optional[str] = None,
                  generate_algorithm: Optional[str] = None,
                  generate_keypair: Optional[bool] = None,
                  generate_length: Optional[int] = None,
                  generate_private_key_password: Optional[str] = None,
                  public_key: Optional[str] = None,
                  user_id: Optional[int] = None)
    func NewPublicKey(ctx *Context, name string, args PublicKeyArgs, opts ...ResourceOption) (*PublicKey, error)
    public PublicKey(string name, PublicKeyArgs args, CustomResourceOptions? opts = null)
    public PublicKey(String name, PublicKeyArgs args)
    public PublicKey(String name, PublicKeyArgs args, CustomResourceOptions options)
    
    type: filescom:PublicKey
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "filescom_public_key" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args PublicKeyArgs
    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 PublicKeyArgs
    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 PublicKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PublicKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PublicKeyArgs
    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 publicKeyResource = new Filescom.PublicKey("publicKeyResource", new()
    {
        Title = "string",
        GenerateAlgorithm = "string",
        GenerateKeypair = false,
        GenerateLength = 0,
        GeneratePrivateKeyPassword = "string",
        PublicKeyContents = "string",
        UserId = 0,
    });
    
    example, err := filescom.NewPublicKey(ctx, "publicKeyResource", &filescom.PublicKeyArgs{
    	Title:                      pulumi.String("string"),
    	GenerateAlgorithm:          pulumi.String("string"),
    	GenerateKeypair:            pulumi.Bool(false),
    	GenerateLength:             pulumi.Int(0),
    	GeneratePrivateKeyPassword: pulumi.String("string"),
    	PublicKey:                  pulumi.String("string"),
    	UserId:                     pulumi.Int(0),
    })
    
    resource "filescom_public_key" "publicKeyResource" {
      lifecycle {
        create_before_destroy = true
      }
      title                         = "string"
      generate_algorithm            = "string"
      generate_keypair              = false
      generate_length               = 0
      generate_private_key_password = "string"
      public_key                    = "string"
      user_id                       = 0
    }
    
    var publicKeyResource = new PublicKey("publicKeyResource", PublicKeyArgs.builder()
        .title("string")
        .generateAlgorithm("string")
        .generateKeypair(false)
        .generateLength(0)
        .generatePrivateKeyPassword("string")
        .publicKey("string")
        .userId(0)
        .build());
    
    public_key_resource = filescom.PublicKey("publicKeyResource",
        title="string",
        generate_algorithm="string",
        generate_keypair=False,
        generate_length=0,
        generate_private_key_password="string",
        public_key="string",
        user_id=0)
    
    const publicKeyResource = new filescom.PublicKey("publicKeyResource", {
        title: "string",
        generateAlgorithm: "string",
        generateKeypair: false,
        generateLength: 0,
        generatePrivateKeyPassword: "string",
        publicKey: "string",
        userId: 0,
    });
    
    type: filescom:PublicKey
    properties:
        generateAlgorithm: string
        generateKeypair: false
        generateLength: 0
        generatePrivateKeyPassword: string
        publicKey: string
        title: string
        userId: 0
    

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

    Title string
    Public key title
    GenerateAlgorithm string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Type of key to generate. One of rsa, dsa, ecdsa, ed25519. 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 SSH key pair. Can not be used with publicKey
    GenerateLength int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Length of key to generate. If algorithm is ecdsa, this is the signature size. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GeneratePrivateKeyPassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the private key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    PublicKeyContents string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Actual contents of SSH key.
    UserId int
    User ID this public key is associated with
    Title string
    Public key title
    GenerateAlgorithm string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Type of key to generate. One of rsa, dsa, ecdsa, ed25519. 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 SSH key pair. Can not be used with publicKey
    GenerateLength int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Length of key to generate. If algorithm is ecdsa, this is the signature size. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GeneratePrivateKeyPassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the private key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    PublicKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Actual contents of SSH key.
    UserId int
    User ID this public key is associated with
    title string
    Public key title
    generate_algorithm string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Type of key to generate. One of rsa, dsa, ecdsa, ed25519. 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 SSH key pair. Can not be used with publicKey
    generate_length number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Length of key to generate. If algorithm is ecdsa, this is the signature size. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generate_private_key_password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the private key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    public_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Actual contents of SSH key.
    user_id number
    User ID this public key is associated with
    title String
    Public key title
    generateAlgorithm String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Type of key to generate. One of rsa, dsa, ecdsa, ed25519. 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 SSH key pair. Can not be used with publicKey
    generateLength Integer
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Length of key to generate. If algorithm is ecdsa, this is the signature size. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generatePrivateKeyPassword String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the private key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    publicKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Actual contents of SSH key.
    userId Integer
    User ID this public key is associated with
    title string
    Public key title
    generateAlgorithm string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Type of key to generate. One of rsa, dsa, ecdsa, ed25519. 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 SSH key pair. Can not be used with publicKey
    generateLength number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Length of key to generate. If algorithm is ecdsa, this is the signature size. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generatePrivateKeyPassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the private key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    publicKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Actual contents of SSH key.
    userId number
    User ID this public key is associated with
    title str
    Public key title
    generate_algorithm str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Type of key to generate. One of rsa, dsa, ecdsa, ed25519. 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 SSH key pair. Can not be used with publicKey
    generate_length int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Length of key to generate. If algorithm is ecdsa, this is the signature size. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generate_private_key_password str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the private key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    public_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Actual contents of SSH key.
    user_id int
    User ID this public key is associated with
    title String
    Public key title
    generateAlgorithm String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Type of key to generate. One of rsa, dsa, ecdsa, ed25519. 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 SSH key pair. Can not be used with publicKey
    generateLength Number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Length of key to generate. If algorithm is ecdsa, this is the signature size. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generatePrivateKeyPassword String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the private key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    publicKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Actual contents of SSH key.
    userId Number
    User ID this public key is associated with

    Outputs

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

    CreatedAt string
    Public key created at date/time
    Expired bool
    Is this public key expired?
    ExpiresAt string
    Public key expiration date/time
    Fingerprint string
    Public key fingerprint (MD5)
    FingerprintSha256 string
    Public key fingerprint (SHA256)
    GeneratedPrivateKey string
    Only returned when generating keys. Private key generated for the user.
    GeneratedPublicKey string
    Only returned when generating keys. Public key generated for the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastLoginAt string
    Key's most recent login time via SFTP
    Status string
    Only returned when generating keys. Can be invalid, not_generated, generating, complete
    Username string
    Username of the user this public key is associated with
    WorkspaceId int
    Workspace ID (0 for default workspace).
    CreatedAt string
    Public key created at date/time
    Expired bool
    Is this public key expired?
    ExpiresAt string
    Public key expiration date/time
    Fingerprint string
    Public key fingerprint (MD5)
    FingerprintSha256 string
    Public key fingerprint (SHA256)
    GeneratedPrivateKey string
    Only returned when generating keys. Private key generated for the user.
    GeneratedPublicKey string
    Only returned when generating keys. Public key generated for the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastLoginAt string
    Key's most recent login time via SFTP
    Status string
    Only returned when generating keys. Can be invalid, not_generated, generating, complete
    Username string
    Username of the user this public key is associated with
    WorkspaceId int
    Workspace ID (0 for default workspace).
    created_at string
    Public key created at date/time
    expired bool
    Is this public key expired?
    expires_at string
    Public key expiration date/time
    fingerprint string
    Public key fingerprint (MD5)
    fingerprint_sha256 string
    Public key fingerprint (SHA256)
    generated_private_key string
    Only returned when generating keys. Private key generated for the user.
    generated_public_key string
    Only returned when generating keys. Public key generated for the user.
    id string
    The provider-assigned unique ID for this managed resource.
    last_login_at string
    Key's most recent login time via SFTP
    status string
    Only returned when generating keys. Can be invalid, not_generated, generating, complete
    username string
    Username of the user this public key is associated with
    workspace_id number
    Workspace ID (0 for default workspace).
    createdAt String
    Public key created at date/time
    expired Boolean
    Is this public key expired?
    expiresAt String
    Public key expiration date/time
    fingerprint String
    Public key fingerprint (MD5)
    fingerprintSha256 String
    Public key fingerprint (SHA256)
    generatedPrivateKey String
    Only returned when generating keys. Private key generated for the user.
    generatedPublicKey String
    Only returned when generating keys. Public key generated for the user.
    id String
    The provider-assigned unique ID for this managed resource.
    lastLoginAt String
    Key's most recent login time via SFTP
    status String
    Only returned when generating keys. Can be invalid, not_generated, generating, complete
    username String
    Username of the user this public key is associated with
    workspaceId Integer
    Workspace ID (0 for default workspace).
    createdAt string
    Public key created at date/time
    expired boolean
    Is this public key expired?
    expiresAt string
    Public key expiration date/time
    fingerprint string
    Public key fingerprint (MD5)
    fingerprintSha256 string
    Public key fingerprint (SHA256)
    generatedPrivateKey string
    Only returned when generating keys. Private key generated for the user.
    generatedPublicKey string
    Only returned when generating keys. Public key generated for the user.
    id string
    The provider-assigned unique ID for this managed resource.
    lastLoginAt string
    Key's most recent login time via SFTP
    status string
    Only returned when generating keys. Can be invalid, not_generated, generating, complete
    username string
    Username of the user this public key is associated with
    workspaceId number
    Workspace ID (0 for default workspace).
    created_at str
    Public key created at date/time
    expired bool
    Is this public key expired?
    expires_at str
    Public key expiration date/time
    fingerprint str
    Public key fingerprint (MD5)
    fingerprint_sha256 str
    Public key fingerprint (SHA256)
    generated_private_key str
    Only returned when generating keys. Private key generated for the user.
    generated_public_key str
    Only returned when generating keys. Public key generated for the user.
    id str
    The provider-assigned unique ID for this managed resource.
    last_login_at str
    Key's most recent login time via SFTP
    status str
    Only returned when generating keys. Can be invalid, not_generated, generating, complete
    username str
    Username of the user this public key is associated with
    workspace_id int
    Workspace ID (0 for default workspace).
    createdAt String
    Public key created at date/time
    expired Boolean
    Is this public key expired?
    expiresAt String
    Public key expiration date/time
    fingerprint String
    Public key fingerprint (MD5)
    fingerprintSha256 String
    Public key fingerprint (SHA256)
    generatedPrivateKey String
    Only returned when generating keys. Private key generated for the user.
    generatedPublicKey String
    Only returned when generating keys. Public key generated for the user.
    id String
    The provider-assigned unique ID for this managed resource.
    lastLoginAt String
    Key's most recent login time via SFTP
    status String
    Only returned when generating keys. Can be invalid, not_generated, generating, complete
    username String
    Username of the user this public key is associated with
    workspaceId Number
    Workspace ID (0 for default workspace).

    Look up Existing PublicKey Resource

    Get an existing PublicKey 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?: PublicKeyState, opts?: CustomResourceOptions): PublicKey
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_at: Optional[str] = None,
            expired: Optional[bool] = None,
            expires_at: Optional[str] = None,
            fingerprint: Optional[str] = None,
            fingerprint_sha256: Optional[str] = None,
            generate_algorithm: Optional[str] = None,
            generate_keypair: Optional[bool] = None,
            generate_length: Optional[int] = None,
            generate_private_key_password: Optional[str] = None,
            generated_private_key: Optional[str] = None,
            generated_public_key: Optional[str] = None,
            last_login_at: Optional[str] = None,
            public_key: Optional[str] = None,
            status: Optional[str] = None,
            title: Optional[str] = None,
            user_id: Optional[int] = None,
            username: Optional[str] = None,
            workspace_id: Optional[int] = None) -> PublicKey
    func GetPublicKey(ctx *Context, name string, id IDInput, state *PublicKeyState, opts ...ResourceOption) (*PublicKey, error)
    public static PublicKey Get(string name, Input<string> id, PublicKeyState? state, CustomResourceOptions? opts = null)
    public static PublicKey get(String name, Output<String> id, PublicKeyState state, CustomResourceOptions options)
    resources:  _:    type: filescom:PublicKey    get:      id: ${id}
    import {
      to = filescom_public_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:
    CreatedAt string
    Public key created at date/time
    Expired bool
    Is this public key expired?
    ExpiresAt string
    Public key expiration date/time
    Fingerprint string
    Public key fingerprint (MD5)
    FingerprintSha256 string
    Public key fingerprint (SHA256)
    GenerateAlgorithm string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Type of key to generate. One of rsa, dsa, ecdsa, ed25519. 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 SSH key pair. Can not be used with publicKey
    GenerateLength int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Length of key to generate. If algorithm is ecdsa, this is the signature size. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GeneratePrivateKeyPassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the private key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GeneratedPrivateKey string
    Only returned when generating keys. Private key generated for the user.
    GeneratedPublicKey string
    Only returned when generating keys. Public key generated for the user.
    LastLoginAt string
    Key's most recent login time via SFTP
    PublicKeyContents string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Actual contents of SSH key.
    Status string
    Only returned when generating keys. Can be invalid, not_generated, generating, complete
    Title string
    Public key title
    UserId int
    User ID this public key is associated with
    Username string
    Username of the user this public key is associated with
    WorkspaceId int
    Workspace ID (0 for default workspace).
    CreatedAt string
    Public key created at date/time
    Expired bool
    Is this public key expired?
    ExpiresAt string
    Public key expiration date/time
    Fingerprint string
    Public key fingerprint (MD5)
    FingerprintSha256 string
    Public key fingerprint (SHA256)
    GenerateAlgorithm string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Type of key to generate. One of rsa, dsa, ecdsa, ed25519. 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 SSH key pair. Can not be used with publicKey
    GenerateLength int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Length of key to generate. If algorithm is ecdsa, this is the signature size. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GeneratePrivateKeyPassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the private key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    GeneratedPrivateKey string
    Only returned when generating keys. Private key generated for the user.
    GeneratedPublicKey string
    Only returned when generating keys. Public key generated for the user.
    LastLoginAt string
    Key's most recent login time via SFTP
    PublicKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Actual contents of SSH key.
    Status string
    Only returned when generating keys. Can be invalid, not_generated, generating, complete
    Title string
    Public key title
    UserId int
    User ID this public key is associated with
    Username string
    Username of the user this public key is associated with
    WorkspaceId int
    Workspace ID (0 for default workspace).
    created_at string
    Public key created at date/time
    expired bool
    Is this public key expired?
    expires_at string
    Public key expiration date/time
    fingerprint string
    Public key fingerprint (MD5)
    fingerprint_sha256 string
    Public key fingerprint (SHA256)
    generate_algorithm string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Type of key to generate. One of rsa, dsa, ecdsa, ed25519. 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 SSH key pair. Can not be used with publicKey
    generate_length number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Length of key to generate. If algorithm is ecdsa, this is the signature size. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generate_private_key_password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the private key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generated_private_key string
    Only returned when generating keys. Private key generated for the user.
    generated_public_key string
    Only returned when generating keys. Public key generated for the user.
    last_login_at string
    Key's most recent login time via SFTP
    public_key string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Actual contents of SSH key.
    status string
    Only returned when generating keys. Can be invalid, not_generated, generating, complete
    title string
    Public key title
    user_id number
    User ID this public key is associated with
    username string
    Username of the user this public key is associated with
    workspace_id number
    Workspace ID (0 for default workspace).
    createdAt String
    Public key created at date/time
    expired Boolean
    Is this public key expired?
    expiresAt String
    Public key expiration date/time
    fingerprint String
    Public key fingerprint (MD5)
    fingerprintSha256 String
    Public key fingerprint (SHA256)
    generateAlgorithm String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Type of key to generate. One of rsa, dsa, ecdsa, ed25519. 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 SSH key pair. Can not be used with publicKey
    generateLength Integer
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Length of key to generate. If algorithm is ecdsa, this is the signature size. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generatePrivateKeyPassword String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the private key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generatedPrivateKey String
    Only returned when generating keys. Private key generated for the user.
    generatedPublicKey String
    Only returned when generating keys. Public key generated for the user.
    lastLoginAt String
    Key's most recent login time via SFTP
    publicKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Actual contents of SSH key.
    status String
    Only returned when generating keys. Can be invalid, not_generated, generating, complete
    title String
    Public key title
    userId Integer
    User ID this public key is associated with
    username String
    Username of the user this public key is associated with
    workspaceId Integer
    Workspace ID (0 for default workspace).
    createdAt string
    Public key created at date/time
    expired boolean
    Is this public key expired?
    expiresAt string
    Public key expiration date/time
    fingerprint string
    Public key fingerprint (MD5)
    fingerprintSha256 string
    Public key fingerprint (SHA256)
    generateAlgorithm string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Type of key to generate. One of rsa, dsa, ecdsa, ed25519. 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 SSH key pair. Can not be used with publicKey
    generateLength number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Length of key to generate. If algorithm is ecdsa, this is the signature size. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generatePrivateKeyPassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the private key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generatedPrivateKey string
    Only returned when generating keys. Private key generated for the user.
    generatedPublicKey string
    Only returned when generating keys. Public key generated for the user.
    lastLoginAt string
    Key's most recent login time via SFTP
    publicKey string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Actual contents of SSH key.
    status string
    Only returned when generating keys. Can be invalid, not_generated, generating, complete
    title string
    Public key title
    userId number
    User ID this public key is associated with
    username string
    Username of the user this public key is associated with
    workspaceId number
    Workspace ID (0 for default workspace).
    created_at str
    Public key created at date/time
    expired bool
    Is this public key expired?
    expires_at str
    Public key expiration date/time
    fingerprint str
    Public key fingerprint (MD5)
    fingerprint_sha256 str
    Public key fingerprint (SHA256)
    generate_algorithm str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Type of key to generate. One of rsa, dsa, ecdsa, ed25519. 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 SSH key pair. Can not be used with publicKey
    generate_length int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Length of key to generate. If algorithm is ecdsa, this is the signature size. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generate_private_key_password str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the private key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generated_private_key str
    Only returned when generating keys. Private key generated for the user.
    generated_public_key str
    Only returned when generating keys. Public key generated for the user.
    last_login_at str
    Key's most recent login time via SFTP
    public_key str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Actual contents of SSH key.
    status str
    Only returned when generating keys. Can be invalid, not_generated, generating, complete
    title str
    Public key title
    user_id int
    User ID this public key is associated with
    username str
    Username of the user this public key is associated with
    workspace_id int
    Workspace ID (0 for default workspace).
    createdAt String
    Public key created at date/time
    expired Boolean
    Is this public key expired?
    expiresAt String
    Public key expiration date/time
    fingerprint String
    Public key fingerprint (MD5)
    fingerprintSha256 String
    Public key fingerprint (SHA256)
    generateAlgorithm String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Type of key to generate. One of rsa, dsa, ecdsa, ed25519. 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 SSH key pair. Can not be used with publicKey
    generateLength Number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Length of key to generate. If algorithm is ecdsa, this is the signature size. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generatePrivateKeyPassword String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Password for the private key. Used for the generation of the key. Will be ignored if generateKeypair is false.
    generatedPrivateKey String
    Only returned when generating keys. Private key generated for the user.
    generatedPublicKey String
    Only returned when generating keys. Public key generated for the user.
    lastLoginAt String
    Key's most recent login time via SFTP
    publicKey String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Actual contents of SSH key.
    status String
    Only returned when generating keys. Can be invalid, not_generated, generating, complete
    title String
    Public key title
    userId Number
    User ID this public key is associated with
    username String
    Username of the user this public key is associated with
    workspaceId Number
    Workspace ID (0 for default workspace).

    Import

    The pulumi import command can be used, for example:

    Public Keys can be imported by specifying the id.

    $ pulumi import filescom:index/publicKey:PublicKey example_public_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