1. Packages
  2. Harness Provider
  3. API Docs
  4. platform
  5. getSecretSshkey
Viewing docs for Harness v0.11.6
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-harness

harness.platform.getSecretSshkey

harness logo
Viewing docs for Harness v0.11.6
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-harness

    Resource for looking up an SSH Key type secret.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as harness from "@pulumi/harness";

const example = harness.platform.getSecretSshkey({
    identifier: "identifier",
});

    import pulumi
import pulumi_harness as harness

example = harness.platform.get_secret_sshkey(identifier="identifier")

    package main

import (
	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := platform.LookupSecretSshkey(ctx, &platform.LookupSecretSshkeyArgs{
			Identifier: "identifier",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Harness = Pulumi.Harness;

return await Deployment.RunAsync(() => 
{
    var example = Harness.Platform.GetSecretSshkey.Invoke(new()
    {
        Identifier = "identifier",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.platform.PlatformFunctions;
import com.pulumi.harness.platform.inputs.GetSecretSshkeyArgs;
import java.util.List;
import java.util.ArrayList;
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 example = PlatformFunctions.getSecretSshkey(GetSecretSshkeyArgs.builder()
            .identifier("identifier")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: harness:platform:getSecretSshkey
      arguments:
        identifier: identifier

    Using getSecretSshkey

    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 getSecretSshkey(args: GetSecretSshkeyArgs, opts?: InvokeOptions): Promise<GetSecretSshkeyResult>
function getSecretSshkeyOutput(args: GetSecretSshkeyOutputArgs, opts?: InvokeOptions): Output<GetSecretSshkeyResult>
    def get_secret_sshkey(identifier: Optional[str] = None,
                      name: Optional[str] = None,
                      org_id: Optional[str] = None,
                      project_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetSecretSshkeyResult
def get_secret_sshkey_output(identifier: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      org_id: Optional[pulumi.Input[str]] = None,
                      project_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetSecretSshkeyResult]
    func LookupSecretSshkey(ctx *Context, args *LookupSecretSshkeyArgs, opts ...InvokeOption) (*LookupSecretSshkeyResult, error)
func LookupSecretSshkeyOutput(ctx *Context, args *LookupSecretSshkeyOutputArgs, opts ...InvokeOption) LookupSecretSshkeyResultOutput

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

    public static class GetSecretSshkey 
{
    public static Task<GetSecretSshkeyResult> InvokeAsync(GetSecretSshkeyArgs args, InvokeOptions? opts = null)
    public static Output<GetSecretSshkeyResult> Invoke(GetSecretSshkeyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSecretSshkeyResult> getSecretSshkey(GetSecretSshkeyArgs args, InvokeOptions options)
public static Output<GetSecretSshkeyResult> getSecretSshkey(GetSecretSshkeyArgs args, InvokeOptions options)

    fn::invoke:
  function: harness:platform/getSecretSshkey:getSecretSshkey
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    identifier str
    Unique identifier of the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.

    getSecretSshkey Result

    The following output properties are available:

    Description string
    Description of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Unique identifier of the resource.
    Kerberos List<GetSecretSshkeyKerbero>
    Kerberos authentication scheme
    Port int
    SSH port
    Sshes List<GetSecretSshkeySsh>
    Kerberos authentication scheme
    Tags List<string>
    Tags to associate with the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Description string
    Description of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Unique identifier of the resource.
    Kerberos []GetSecretSshkeyKerbero
    Kerberos authentication scheme
    Port int
    SSH port
    Sshes []GetSecretSshkeySsh
    Kerberos authentication scheme
    Tags []string
    Tags to associate with the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    description String
    Description of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Unique identifier of the resource.
    kerberos List<GetSecretSshkeyKerbero>
    Kerberos authentication scheme
    port Integer
    SSH port
    sshes List<GetSecretSshkeySsh>
    Kerberos authentication scheme
    tags List<String>
    Tags to associate with the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    description string
    Description of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    identifier string
    Unique identifier of the resource.
    kerberos GetSecretSshkeyKerbero[]
    Kerberos authentication scheme
    port number
    SSH port
    sshes GetSecretSshkeySsh[]
    Kerberos authentication scheme
    tags string[]
    Tags to associate with the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    description str
    Description of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    identifier str
    Unique identifier of the resource.
    kerberos Sequence[GetSecretSshkeyKerbero]
    Kerberos authentication scheme
    port int
    SSH port
    sshes Sequence[GetSecretSshkeySsh]
    Kerberos authentication scheme
    tags Sequence[str]
    Tags to associate with the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    description String
    Description of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Unique identifier of the resource.
    kerberos List<Property Map>
    Kerberos authentication scheme
    port Number
    SSH port
    sshes List<Property Map>
    Kerberos authentication scheme
    tags List<String>
    Tags to associate with the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.

    Supporting Types

    GetSecretSshkeyKerbero

    Principal string
    Username to use for authentication.
    Realm string
    Reference to a secret containing the password to use for authentication.
    TgtGenerationMethod string
    Method to generate tgt
    TgtKeyTabFilePathSpecs List<GetSecretSshkeyKerberoTgtKeyTabFilePathSpec>
    Authenticate to App Dynamics using username and password.
    TgtPasswordSpecs List<GetSecretSshkeyKerberoTgtPasswordSpec>
    Authenticate to App Dynamics using username and password.
    Principal string
    Username to use for authentication.
    Realm string
    Reference to a secret containing the password to use for authentication.
    TgtGenerationMethod string
    Method to generate tgt
    TgtKeyTabFilePathSpecs []GetSecretSshkeyKerberoTgtKeyTabFilePathSpec
    Authenticate to App Dynamics using username and password.
    TgtPasswordSpecs []GetSecretSshkeyKerberoTgtPasswordSpec
    Authenticate to App Dynamics using username and password.
    principal String
    Username to use for authentication.
    realm String
    Reference to a secret containing the password to use for authentication.
    tgtGenerationMethod String
    Method to generate tgt
    tgtKeyTabFilePathSpecs List<GetSecretSshkeyKerberoTgtKeyTabFilePathSpec>
    Authenticate to App Dynamics using username and password.
    tgtPasswordSpecs List<GetSecretSshkeyKerberoTgtPasswordSpec>
    Authenticate to App Dynamics using username and password.
    principal string
    Username to use for authentication.
    realm string
    Reference to a secret containing the password to use for authentication.
    tgtGenerationMethod string
    Method to generate tgt
    tgtKeyTabFilePathSpecs GetSecretSshkeyKerberoTgtKeyTabFilePathSpec[]
    Authenticate to App Dynamics using username and password.
    tgtPasswordSpecs GetSecretSshkeyKerberoTgtPasswordSpec[]
    Authenticate to App Dynamics using username and password.
    principal str
    Username to use for authentication.
    realm str
    Reference to a secret containing the password to use for authentication.
    tgt_generation_method str
    Method to generate tgt
    tgt_key_tab_file_path_specs Sequence[GetSecretSshkeyKerberoTgtKeyTabFilePathSpec]
    Authenticate to App Dynamics using username and password.
    tgt_password_specs Sequence[GetSecretSshkeyKerberoTgtPasswordSpec]
    Authenticate to App Dynamics using username and password.
    principal String
    Username to use for authentication.
    realm String
    Reference to a secret containing the password to use for authentication.
    tgtGenerationMethod String
    Method to generate tgt
    tgtKeyTabFilePathSpecs List<Property Map>
    Authenticate to App Dynamics using username and password.
    tgtPasswordSpecs List<Property Map>
    Authenticate to App Dynamics using username and password.

    GetSecretSshkeyKerberoTgtKeyTabFilePathSpec

    KeyPath string
    key path
    KeyPath string
    key path
    keyPath String
    key path
    keyPath string
    key path
    key_path str
    key path
    keyPath String
    key path

    GetSecretSshkeyKerberoTgtPasswordSpec

    Password string
    password
    Password string
    password
    password String
    password
    password string
    password
    password str
    password
    password String
    password

    GetSecretSshkeySsh

    CredentialType string
    This specifies SSH credential type as Password, KeyPath or KeyReference
    SshPasswordCredentials List<GetSecretSshkeySshSshPasswordCredential>
    SSH credential of type keyReference
    SshkeyPathCredentials List<GetSecretSshkeySshSshkeyPathCredential>
    SSH credential of type keyPath
    SshkeyReferenceCredentials List<GetSecretSshkeySshSshkeyReferenceCredential>
    SSH credential of type keyReference
    CredentialType string
    This specifies SSH credential type as Password, KeyPath or KeyReference
    SshPasswordCredentials []GetSecretSshkeySshSshPasswordCredential
    SSH credential of type keyReference
    SshkeyPathCredentials []GetSecretSshkeySshSshkeyPathCredential
    SSH credential of type keyPath
    SshkeyReferenceCredentials []GetSecretSshkeySshSshkeyReferenceCredential
    SSH credential of type keyReference
    credentialType String
    This specifies SSH credential type as Password, KeyPath or KeyReference
    sshPasswordCredentials List<GetSecretSshkeySshSshPasswordCredential>
    SSH credential of type keyReference
    sshkeyPathCredentials List<GetSecretSshkeySshSshkeyPathCredential>
    SSH credential of type keyPath
    sshkeyReferenceCredentials List<GetSecretSshkeySshSshkeyReferenceCredential>
    SSH credential of type keyReference
    credentialType string
    This specifies SSH credential type as Password, KeyPath or KeyReference
    sshPasswordCredentials GetSecretSshkeySshSshPasswordCredential[]
    SSH credential of type keyReference
    sshkeyPathCredentials GetSecretSshkeySshSshkeyPathCredential[]
    SSH credential of type keyPath
    sshkeyReferenceCredentials GetSecretSshkeySshSshkeyReferenceCredential[]
    SSH credential of type keyReference
    credential_type str
    This specifies SSH credential type as Password, KeyPath or KeyReference
    ssh_password_credentials Sequence[GetSecretSshkeySshSshPasswordCredential]
    SSH credential of type keyReference
    sshkey_path_credentials Sequence[GetSecretSshkeySshSshkeyPathCredential]
    SSH credential of type keyPath
    sshkey_reference_credentials Sequence[GetSecretSshkeySshSshkeyReferenceCredential]
    SSH credential of type keyReference
    credentialType String
    This specifies SSH credential type as Password, KeyPath or KeyReference
    sshPasswordCredentials List<Property Map>
    SSH credential of type keyReference
    sshkeyPathCredentials List<Property Map>
    SSH credential of type keyPath
    sshkeyReferenceCredentials List<Property Map>
    SSH credential of type keyReference

    GetSecretSshkeySshSshPasswordCredential

    Password string
    SSH Password.
    UserName string
    SSH Username.
    Password string
    SSH Password.
    UserName string
    SSH Username.
    password String
    SSH Password.
    userName String
    SSH Username.
    password string
    SSH Password.
    userName string
    SSH Username.
    password str
    SSH Password.
    user_name str
    SSH Username.
    password String
    SSH Password.
    userName String
    SSH Username.

    GetSecretSshkeySshSshkeyPathCredential

    EncryptedPassphrase string
    Encrypted Passphrase
    KeyPath string
    Path of the key file.
    UserName string
    SSH Username.
    EncryptedPassphrase string
    Encrypted Passphrase
    KeyPath string
    Path of the key file.
    UserName string
    SSH Username.
    encryptedPassphrase String
    Encrypted Passphrase
    keyPath String
    Path of the key file.
    userName String
    SSH Username.
    encryptedPassphrase string
    Encrypted Passphrase
    keyPath string
    Path of the key file.
    userName string
    SSH Username.
    encrypted_passphrase str
    Encrypted Passphrase
    key_path str
    Path of the key file.
    user_name str
    SSH Username.
    encryptedPassphrase String
    Encrypted Passphrase
    keyPath String
    Path of the key file.
    userName String
    SSH Username.

    GetSecretSshkeySshSshkeyReferenceCredential

    EncryptedAssphrase string
    Encrypted Passphrase
    Key string
    SSH key.
    UserName string
    SSH Username.
    EncryptedAssphrase string
    Encrypted Passphrase
    Key string
    SSH key.
    UserName string
    SSH Username.
    encryptedAssphrase String
    Encrypted Passphrase
    key String
    SSH key.
    userName String
    SSH Username.
    encryptedAssphrase string
    Encrypted Passphrase
    key string
    SSH key.
    userName string
    SSH Username.
    encrypted_assphrase str
    Encrypted Passphrase
    key str
    SSH key.
    user_name str
    SSH Username.
    encryptedAssphrase String
    Encrypted Passphrase
    key String
    SSH key.
    userName String
    SSH Username.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Viewing docs for Harness v0.11.6
    published on Thursday, Mar 12, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-harness
      Try Pulumi Cloud free. Your team will thank you.