Frodo Library - v4.0.0-10
    Preparing search index...

    Type Alias Secret

    type Secret = {
        createNewVersionOfSecret(
            secretId: string,
            value: string,
        ): Promise<VersionOfSecretSkeleton>;
        createSecret(
            secretId: string,
            value: string,
            description: string,
            encoding?: string,
            useInPlaceholders?: boolean,
        ): Promise<SecretSkeleton>;
        createVersionOfSecret(
            secretId: string,
            value: string,
        ): Promise<VersionOfSecretSkeleton>;
        deleteSecret(secretId: string): Promise<SecretSkeleton>;
        deleteVersionOfSecret(
            secretId: string,
            version: string,
        ): Promise<VersionOfSecretSkeleton>;
        disableVersionOfSecret(
            secretId: string,
            version: string,
        ): Promise<VersionOfSecretSkeleton>;
        enableVersionOfSecret(
            secretId: string,
            version: string,
        ): Promise<VersionOfSecretSkeleton>;
        exportSecret(
            secretId: string,
            includeActiveValue?: boolean,
            target?: string,
        ): Promise<SecretsExportInterface>;
        exportSecrets(
            includeActiveValues?: boolean,
            target?: string,
        ): Promise<SecretsExportInterface>;
        getSecret(secretId: string): Promise<SecretSkeleton>;
        getSecrets(): Promise<SecretSkeleton[]>;
        getSecretVersions(secretId: string): Promise<VersionOfSecretSkeleton[]>;
        getVersionOfSecret(
            secretId: string,
            version: string,
        ): Promise<VersionOfSecretSkeleton>;
        importSecret(
            secretId: string,
            importData: SecretsExportInterface,
            includeActiveValue?: boolean,
            source?: string,
        ): Promise<SecretSkeleton>;
        importSecrets(
            importData: SecretsExportInterface,
            includeActiveValues?: boolean,
            source?: string,
        ): Promise<SecretSkeleton[]>;
        putSecret(
            secretId: string,
            value: string,
            description: string,
            encoding?: string,
            useInPlaceholders?: boolean,
        ): Promise<SecretSkeleton>;
        readSecret(secretId: string): Promise<SecretSkeleton>;
        readSecrets(): Promise<SecretSkeleton[]>;
        readSecretValue(
            secretId: string,
            target?: string,
            decrypt?: boolean,
        ): Promise<any>;
        readSecretValues(
            secretIds: string[],
            target?: string,
            decrypt?: boolean,
        ): Promise<{ [key: string]: string }>;
        readVersionOfSecret(
            secretId: string,
            version: string,
        ): Promise<VersionOfSecretSkeleton>;
        readVersionsOfSecret(secretId: string): Promise<VersionOfSecretSkeleton[]>;
        setSecretDescription(secretId: string, description: string): Promise<any>;
        setStatusOfVersionOfSecret(
            secretId: string,
            version: string,
            status: VersionOfSecretStatus,
        ): Promise<VersionOfSecretSkeleton>;
        updateSecretDescription(
            secretId: string,
            description: string,
        ): Promise<any>;
    }
    Index

    Methods

    createSecret createVersionOfSecret deleteSecret deleteVersionOfSecret disableVersionOfSecret enableVersionOfSecret exportSecret exportSecrets importSecret importSecrets readSecret readSecrets readSecretValue readSecretValues readVersionOfSecret readVersionsOfSecret updateSecretDescription

    Deprecated

    createNewVersionOfSecret getSecret getSecrets getSecretVersions getVersionOfSecret putSecret setSecretDescription setStatusOfVersionOfSecret

    Methods

    • 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

    • 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.

    • 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.

    • 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

    • 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

    • 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

    • 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

    • Update secret description

      Parameters

      • secretId: string

        secret id/name

      • description: string

        secret description

      Returns Promise<any>

      a promise that resolves to an empty string

    Deprecated

    • 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

      since v2.0.0 use createSecret instead

      createSecret(secretId: string, value: string, description: string, encoding?: string, useInPlaceholders?: boolean): 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

      since v2.0.0 use updateSecretDescription instead

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

    Settings

    Member Visibility

    On This Page

    Methods
    Deprecated