1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getRemoteServerCredential
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 RemoteServerCredential is a way to store a credential for Remote Servers in a centralized vault and then reference it from Remote Server definitions.

    This allows you to manage your credentials in one place and avoid duplicating them across multiple Remote Server configurations. It also improves security. You can manage the Remote Servers with Pulumi or with the API, and the credential stays in the vault.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const exampleRemoteServerCredential = filescom.getRemoteServerCredential({
        id: 1,
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_remote_server_credential = filescom.get_remote_server_credential(id=1)
    
    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.GetRemoteServerCredential(ctx, &filescom.LookupRemoteServerCredentialArgs{
    			Id: 1,
    		}, nil)
    		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 exampleRemoteServerCredential = Filescom.GetRemoteServerCredential.Invoke(new()
        {
            Id = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.FilescomFunctions;
    import com.pulumi.filescom.inputs.GetRemoteServerCredentialArgs;
    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) {
            final var exampleRemoteServerCredential = FilescomFunctions.getRemoteServerCredential(GetRemoteServerCredentialArgs.builder()
                .id(1)
                .build());
    
        }
    }
    
    variables:
      exampleRemoteServerCredential:
        fn::invoke:
          function: filescom:getRemoteServerCredential
          arguments:
            id: 1
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    data "filescom_getremoteservercredential" "exampleRemoteServerCredential" {
      id = 1
    }
    

    Using getRemoteServerCredential

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

    function getRemoteServerCredential(args: GetRemoteServerCredentialArgs, opts?: InvokeOptions): Promise<GetRemoteServerCredentialResult>
    function getRemoteServerCredentialOutput(args: GetRemoteServerCredentialOutputArgs, opts?: InvokeOutputOptions): Output<GetRemoteServerCredentialResult>
    def get_remote_server_credential(id: Optional[int] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetRemoteServerCredentialResult
    def get_remote_server_credential_output(id: pulumi.Input[Optional[int]] = None,
                                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetRemoteServerCredentialResult]
    func LookupRemoteServerCredential(ctx *Context, args *LookupRemoteServerCredentialArgs, opts ...InvokeOption) (*LookupRemoteServerCredentialResult, error)
    func LookupRemoteServerCredentialOutput(ctx *Context, args *LookupRemoteServerCredentialOutputArgs, opts ...InvokeOption) LookupRemoteServerCredentialResultOutput

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

    public static class GetRemoteServerCredential 
    {
        public static Task<GetRemoteServerCredentialResult> InvokeAsync(GetRemoteServerCredentialArgs args, InvokeOptions? opts = null)
        public static Output<GetRemoteServerCredentialResult> Invoke(GetRemoteServerCredentialInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetRemoteServerCredentialResult> Invoke(GetRemoteServerCredentialInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetRemoteServerCredentialResult> getRemoteServerCredential(GetRemoteServerCredentialArgs args, InvokeOptions options)
    public static Output<GetRemoteServerCredentialResult> getRemoteServerCredential(GetRemoteServerCredentialArgs args, InvokeOptions options)
    public static Output<GetRemoteServerCredentialResult> getRemoteServerCredential(GetRemoteServerCredentialArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: filescom:index/getRemoteServerCredential:getRemoteServerCredential
      arguments:
        # arguments dictionary
    data "filescom_get_remote_server_credential" "name" {
        # arguments
    }

    The following arguments are supported:

    Id int
    Remote Server Credential ID
    Id int
    Remote Server Credential ID
    id number
    Remote Server Credential ID
    id Integer
    Remote Server Credential ID
    id number
    Remote Server Credential ID
    id int
    Remote Server Credential ID
    id Number
    Remote Server Credential ID

    getRemoteServerCredential Result

    The following output properties are available:

    AwsAccessKey string
    AWS Access Key.
    CloudflareAccessKey string
    Cloudflare: Access Key.
    Description string
    Internal description for your reference
    FilebaseAccessKey string
    Filebase: Access Key.
    GoogleCloudStorageS3CompatibleAccessKey string
    Google Cloud Storage: S3-compatible Access Key.
    Id int
    Remote Server Credential ID
    LinodeAccessKey string
    Linode: Access Key
    Name string
    Internal name for your reference
    S3AssumeRoleArn string
    AWS IAM Role ARN for AssumeRole authentication.
    S3AssumeRoleDurationSeconds int
    Session duration in seconds for AssumeRole authentication (900-43200).
    S3AssumeRoleExternalId string
    External ID for AssumeRole authentication.
    S3CompatibleAccessKey string
    S3-compatible: Access Key
    ServerType string
    Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
    SharepointAppCredentialType string
    SharePoint: App-only credential type. Either secret or certificate.
    SharepointClientId string
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    SharepointTenantId string
    SharePoint: Microsoft Entra tenant ID for app-only authentication.
    Username string
    Remote server username.
    WasabiAccessKey string
    Wasabi: Access Key.
    WorkspaceId int
    Workspace ID (0 for default workspace)
    AwsAccessKey string
    AWS Access Key.
    CloudflareAccessKey string
    Cloudflare: Access Key.
    Description string
    Internal description for your reference
    FilebaseAccessKey string
    Filebase: Access Key.
    GoogleCloudStorageS3CompatibleAccessKey string
    Google Cloud Storage: S3-compatible Access Key.
    Id int
    Remote Server Credential ID
    LinodeAccessKey string
    Linode: Access Key
    Name string
    Internal name for your reference
    S3AssumeRoleArn string
    AWS IAM Role ARN for AssumeRole authentication.
    S3AssumeRoleDurationSeconds int
    Session duration in seconds for AssumeRole authentication (900-43200).
    S3AssumeRoleExternalId string
    External ID for AssumeRole authentication.
    S3CompatibleAccessKey string
    S3-compatible: Access Key
    ServerType string
    Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
    SharepointAppCredentialType string
    SharePoint: App-only credential type. Either secret or certificate.
    SharepointClientId string
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    SharepointTenantId string
    SharePoint: Microsoft Entra tenant ID for app-only authentication.
    Username string
    Remote server username.
    WasabiAccessKey string
    Wasabi: Access Key.
    WorkspaceId int
    Workspace ID (0 for default workspace)
    aws_access_key string
    AWS Access Key.
    cloudflare_access_key string
    Cloudflare: Access Key.
    description string
    Internal description for your reference
    filebase_access_key string
    Filebase: Access Key.
    google_cloud_storage_s3_compatible_access_key string
    Google Cloud Storage: S3-compatible Access Key.
    id number
    Remote Server Credential ID
    linode_access_key string
    Linode: Access Key
    name string
    Internal name for your reference
    s3_assume_role_arn string
    AWS IAM Role ARN for AssumeRole authentication.
    s3_assume_role_duration_seconds number
    Session duration in seconds for AssumeRole authentication (900-43200).
    s3_assume_role_external_id string
    External ID for AssumeRole authentication.
    s3_compatible_access_key string
    S3-compatible: Access Key
    server_type string
    Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
    sharepoint_app_credential_type string
    SharePoint: App-only credential type. Either secret or certificate.
    sharepoint_client_id string
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepoint_tenant_id string
    SharePoint: Microsoft Entra tenant ID for app-only authentication.
    username string
    Remote server username.
    wasabi_access_key string
    Wasabi: Access Key.
    workspace_id number
    Workspace ID (0 for default workspace)
    awsAccessKey String
    AWS Access Key.
    cloudflareAccessKey String
    Cloudflare: Access Key.
    description String
    Internal description for your reference
    filebaseAccessKey String
    Filebase: Access Key.
    googleCloudStorageS3CompatibleAccessKey String
    Google Cloud Storage: S3-compatible Access Key.
    id Integer
    Remote Server Credential ID
    linodeAccessKey String
    Linode: Access Key
    name String
    Internal name for your reference
    s3AssumeRoleArn String
    AWS IAM Role ARN for AssumeRole authentication.
    s3AssumeRoleDurationSeconds Integer
    Session duration in seconds for AssumeRole authentication (900-43200).
    s3AssumeRoleExternalId String
    External ID for AssumeRole authentication.
    s3CompatibleAccessKey String
    S3-compatible: Access Key
    serverType String
    Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
    sharepointAppCredentialType String
    SharePoint: App-only credential type. Either secret or certificate.
    sharepointClientId String
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepointTenantId String
    SharePoint: Microsoft Entra tenant ID for app-only authentication.
    username String
    Remote server username.
    wasabiAccessKey String
    Wasabi: Access Key.
    workspaceId Integer
    Workspace ID (0 for default workspace)
    awsAccessKey string
    AWS Access Key.
    cloudflareAccessKey string
    Cloudflare: Access Key.
    description string
    Internal description for your reference
    filebaseAccessKey string
    Filebase: Access Key.
    googleCloudStorageS3CompatibleAccessKey string
    Google Cloud Storage: S3-compatible Access Key.
    id number
    Remote Server Credential ID
    linodeAccessKey string
    Linode: Access Key
    name string
    Internal name for your reference
    s3AssumeRoleArn string
    AWS IAM Role ARN for AssumeRole authentication.
    s3AssumeRoleDurationSeconds number
    Session duration in seconds for AssumeRole authentication (900-43200).
    s3AssumeRoleExternalId string
    External ID for AssumeRole authentication.
    s3CompatibleAccessKey string
    S3-compatible: Access Key
    serverType string
    Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
    sharepointAppCredentialType string
    SharePoint: App-only credential type. Either secret or certificate.
    sharepointClientId string
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepointTenantId string
    SharePoint: Microsoft Entra tenant ID for app-only authentication.
    username string
    Remote server username.
    wasabiAccessKey string
    Wasabi: Access Key.
    workspaceId number
    Workspace ID (0 for default workspace)
    aws_access_key str
    AWS Access Key.
    cloudflare_access_key str
    Cloudflare: Access Key.
    description str
    Internal description for your reference
    filebase_access_key str
    Filebase: Access Key.
    google_cloud_storage_s3_compatible_access_key str
    Google Cloud Storage: S3-compatible Access Key.
    id int
    Remote Server Credential ID
    linode_access_key str
    Linode: Access Key
    name str
    Internal name for your reference
    s3_assume_role_arn str
    AWS IAM Role ARN for AssumeRole authentication.
    s3_assume_role_duration_seconds int
    Session duration in seconds for AssumeRole authentication (900-43200).
    s3_assume_role_external_id str
    External ID for AssumeRole authentication.
    s3_compatible_access_key str
    S3-compatible: Access Key
    server_type str
    Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
    sharepoint_app_credential_type str
    SharePoint: App-only credential type. Either secret or certificate.
    sharepoint_client_id str
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepoint_tenant_id str
    SharePoint: Microsoft Entra tenant ID for app-only authentication.
    username str
    Remote server username.
    wasabi_access_key str
    Wasabi: Access Key.
    workspace_id int
    Workspace ID (0 for default workspace)
    awsAccessKey String
    AWS Access Key.
    cloudflareAccessKey String
    Cloudflare: Access Key.
    description String
    Internal description for your reference
    filebaseAccessKey String
    Filebase: Access Key.
    googleCloudStorageS3CompatibleAccessKey String
    Google Cloud Storage: S3-compatible Access Key.
    id Number
    Remote Server Credential ID
    linodeAccessKey String
    Linode: Access Key
    name String
    Internal name for your reference
    s3AssumeRoleArn String
    AWS IAM Role ARN for AssumeRole authentication.
    s3AssumeRoleDurationSeconds Number
    Session duration in seconds for AssumeRole authentication (900-43200).
    s3AssumeRoleExternalId String
    External ID for AssumeRole authentication.
    s3CompatibleAccessKey String
    S3-compatible: Access Key
    serverType String
    Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
    sharepointAppCredentialType String
    SharePoint: App-only credential type. Either secret or certificate.
    sharepointClientId String
    SharePoint: Microsoft Entra application client ID for app-only authentication.
    sharepointTenantId String
    SharePoint: Microsoft Entra tenant ID for app-only authentication.
    username String
    Remote server username.
    wasabiAccessKey String
    Wasabi: Access Key.
    workspaceId Number
    Workspace ID (0 for default workspace)

    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