Type Alias Secret

Type declaration

• createNewVersionOfSecret:function

  • createNewVersionOfSecret(
        secretId: string,
        value: string,
    ): Promise<VersionOfSecretSkeleton>

    Create new secret version

    Parameters

    • secretId: string

      secret id/name
    • value: string

      secret value

    Returns Promise<VersionOfSecretSkeleton>

    a promise that resolves to a version object

    Deprecated

    since v2.0.0 use createVersionOfSecret instead

    createVersionOfSecret(secretId: string, value: string): Promise<any>
    Copy

• createSecret:function

  • createSecret(
        secretId: string,
        value: string,
        description: string,
        encoding?: string,
        useInPlaceholders?: boolean,
    ): Promise<SecretSkeleton>

    Create secret

    Parameters

    • secretId: string

      secret id/name
    • value: string

      secret value
    • description: string

      secret description
    • Optionalencoding: string

      secret encoding (only generic is supported)
    • OptionaluseInPlaceholders: boolean

      flag indicating if the secret can be used in placeholders

    Returns Promise<SecretSkeleton>

    a promise that resolves to a secret

• createVersionOfSecret:function

  • createVersionOfSecret(
        secretId: string,
        value: string,
    ): Promise<VersionOfSecretSkeleton>

    Create version of secret

    Parameters

    • secretId: string

      secret id/name
    • value: string

      secret value

    Returns Promise<VersionOfSecretSkeleton>

    a promise that resolves to a version object

• deleteSecret:function

  • deleteSecret(secretId: string): Promise<SecretSkeleton>

    Delete secret

    Parameters

    • secretId: string

      secret id/name

    Returns Promise<SecretSkeleton>

    a promise that resolves to a secret object

• deleteVersionOfSecret:function

  • deleteVersionOfSecret(
        secretId: string,
        version: string,
    ): Promise<VersionOfSecretSkeleton>

    Delete version of secret

    Parameters

    • secretId: string

      secret id/name
    • version: string

      secret version

    Returns Promise<VersionOfSecretSkeleton>

    a promise that resolves to a version object

• disableVersionOfSecret:function

  • disableVersionOfSecret(
        secretId: string,
        version: string,
    ): Promise<VersionOfSecretSkeleton>

    Disable a version of a secret

    Parameters

    • secretId: string

      secret id/name
    • version: string

      secret version

    Returns Promise<VersionOfSecretSkeleton>

    a promise that resolves to a status object

• enableVersionOfSecret:function

  • enableVersionOfSecret(
        secretId: string,
        version: string,
    ): Promise<VersionOfSecretSkeleton>

    Enable a version of a secret

    Parameters

    • secretId: string

      secret id/name
    • version: string

      secret version

    Returns Promise<VersionOfSecretSkeleton>

    a promise that resolves to a status object

• exportSecret:function

  • exportSecret(
        secretId: string,
        includeActiveValue?: boolean,
        target?: string,
    ): Promise<SecretsExportInterface>

    Export secret. The response can be saved to file as is.

    Parameters

    • secretId: string

      secret id/name
    • OptionalincludeActiveValue: boolean

      include active value of secret (default: false)
    • Optionaltarget: string

      Host URL of target environment to encrypt secret value for

    Returns Promise<SecretsExportInterface>

    Promise resolving to a SecretsExportInterface object.

• exportSecrets:function

  • exportSecrets(
        includeActiveValues?: boolean,
        target?: string,
    ): Promise<SecretsExportInterface>

    Export all secrets

    Parameters

    • OptionalincludeActiveValues: boolean

      include active values of secrets (default: false)
    • Optionaltarget: string

      Host URL of target environment to encrypt secret values for

    Returns Promise<SecretsExportInterface>

    Promise resolving to an SecretsExportInterface object.

• getSecret:function

  • getSecret(secretId: string): Promise<SecretSkeleton>

    Get secret

    Parameters

    • secretId: string

      secret id/name

    Returns Promise<SecretSkeleton>

    a promise that resolves to a secret

    Deprecated

    since v2.0.0 use readSecret instead

    readSecret(secretId: string): Promise<any>
    Copy

• getSecrets:function

  • getSecrets(): Promise<SecretSkeleton[]>

    Get all secrets

    Returns Promise<SecretSkeleton[]>

    a promise that resolves to an array of secrets

    Deprecated

    since v2.0.0 use readSecrets instead

    readSecrets(): Promise<SecretSkeleton[]>
    Copy

• getSecretVersions:function

  • getSecretVersions(secretId: string): Promise<VersionOfSecretSkeleton[]>

    Get secret versions

    Parameters

    • secretId: string

      secret id/name

    Returns Promise<VersionOfSecretSkeleton[]>

    a promise that resolves to an array of secret versions

    Deprecated

    since v2.0.0 use readVersionsOfSecret instead

    readVersionsOfSecret(secretId: string): Promise<any>
    Copy

• getVersionOfSecret:function

  • getVersionOfSecret(
        secretId: string,
        version: string,
    ): Promise<VersionOfSecretSkeleton>

    Get version of secret

    Parameters

    • secretId: string

      secret id/name
    • version: string

      secret version

    Returns Promise<VersionOfSecretSkeleton>

    a promise that resolves to a version object

    Deprecated

    since v2.0.0 use readVersionOfSecret instead

    readVersionOfSecret(secretId: string, version: string): Promise<any>
    Copy

• importSecret:function

  • importSecret(
        secretId: string,
        importData: SecretsExportInterface,
        includeActiveValue?: boolean,
        source?: string,
    ): Promise<SecretSkeleton>

    Import secret by id

    Parameters

    • secretId: string

      secret id/name
    • importData: SecretsExportInterface

      import data
    • OptionalincludeActiveValue: boolean

      include active value of secret (default: false)
    • Optionalsource: string

      Host URL of source environment where the secret was exported from

    Returns Promise<SecretSkeleton>

    imported secret object

• importSecrets:function

  • importSecrets(
        importData: SecretsExportInterface,
        includeActiveValues?: boolean,
        source?: string,
    ): Promise<SecretSkeleton[]>

    Import secrets

    Parameters

    • importData: SecretsExportInterface

      import data
    • OptionalincludeActiveValues: boolean

      include active values of secrets (default: false)
    • Optionalsource: string

      Host URL of source environment where the secrets were exported from

    Returns Promise<SecretSkeleton[]>

    array of imported secret objects

• putSecret:function

  • putSecret(
        secretId: string,
        value: string,
        description: string,
        encoding?: string,
        useInPlaceholders?: boolean,
    ): Promise<SecretSkeleton>

    Create secret

    Parameters

    • secretId: string

      secret id/name
    • value: string

      secret value
    • description: string

      secret description
    • Optionalencoding: string

      secret encoding (only generic is supported)
    • OptionaluseInPlaceholders: boolean

      flag indicating if the secret can be used in placeholders

    Returns Promise<SecretSkeleton>

    a promise that resolves to a secret

    Deprecated

    since v2.0.0 use createSecret instead

    createSecret(secretId: string, value: string, description: string, encoding?: string, useInPlaceholders?: boolean): Promise<any>
    Copy

• readSecret:function

  • readSecret(secretId: string): Promise<SecretSkeleton>

    Read secret

    Parameters

    • secretId: string

      secret id/name

    Returns Promise<SecretSkeleton>

    a promise that resolves to a secret

• readSecrets:function

  • readSecrets(): Promise<SecretSkeleton[]>

    Read all secrets

    Returns Promise<SecretSkeleton[]>

    a promise that resolves to an array of secrets

• readSecretValue:function

  • readSecretValue(
        secretId: string,
        target?: string,
        decrypt?: boolean,
    ): Promise<any>

    Read the value of a secret

    Parameters

    • secretId: string

      secret id/name
    • Optionaltarget: string

      Host URL of target environment to encrypt secret value for
    • Optionaldecrypt: boolean

      retrieve secret value in the clear (default: false)

    Returns Promise<any>

    a promise that resolves to the value of the secret

• readSecretValues:function

  • readSecretValues(
        secretIds: string[],
        target?: string,
        decrypt?: boolean,
    ): Promise<{ [key: string]: string }>

    Read the values of an array of secrets

    Parameters

    • secretIds: string[]

      secret id/name
    • Optionaltarget: string

      Host URL of target environment to encrypt secret values for
    • Optionaldecrypt: boolean

      retrieve secret values in the clear (default: false)

    Returns Promise<{ [key: string]: string }>

    a promise that resolves to a map of secret ids and values

• readVersionOfSecret:function

  • readVersionOfSecret(
        secretId: string,
        version: string,
    ): Promise<VersionOfSecretSkeleton>

    Read version of secret

    Parameters

    • secretId: string

      secret id/name
    • version: string

      secret version

    Returns Promise<VersionOfSecretSkeleton>

    a promise that resolves to a version object

• readVersionsOfSecret:function

  • readVersionsOfSecret(secretId: string): Promise<VersionOfSecretSkeleton[]>

    Read versions of secret

    Parameters

    • secretId: string

      secret id/name

    Returns Promise<VersionOfSecretSkeleton[]>

    a promise that resolves to an array of secret versions

• setSecretDescription:function

  • setSecretDescription(secretId: string, description: string): Promise<any>

    Set secret description

    Parameters

    • secretId: string

      secret id/name
    • description: string

      secret description

    Returns Promise<any>

    a promise that resolves to an empty string

    Deprecated

    since v2.0.0 use updateSecretDescription instead

    updateSecretDescription(secretId: string, description: string): Promise<any>
    Copy

• setStatusOfVersionOfSecret:function

  • setStatusOfVersionOfSecret(
        secretId: string,
        version: string,
        status: VersionOfSecretStatus,
    ): Promise<VersionOfSecretSkeleton>

    Update the status of a version of a secret

    Parameters

    • secretId: string

      secret id/name
    • version: string

      secret version
    • status: VersionOfSecretStatus

      status

    Returns Promise<VersionOfSecretSkeleton>

    a promise that resolves to a status object

    Deprecated

    since v2.0.0 use enableVersionOfSecret or disableVersionOfSecret instead

    enableVersionOfSecret(secretId: string, version: string): Promise<any>
    disableVersionOfSecret(secretId: string, version: string): Promise<any>
    Copy

• updateSecretDescription:function

  • updateSecretDescription(secretId: string, description: string): Promise<any>

    Update secret description

    Parameters

    • secretId: string

      secret id/name
    • description: string

      secret description

    Returns Promise<any>

    a promise that resolves to an empty string