Type Alias SecretStore

Type declaration

• createSecretStoreExportTemplate:function

  • createSecretStoreExportTemplate(): SecretStoreExportInterface

    Create an empty secret store export template

    Returns SecretStoreExportInterface

    an empty secret store export template

• exportSecretStore:function

  • exportSecretStore(
        secretStoreId: string,
        globalConfig: boolean,
    ): Promise<SecretStoreExportInterface>

    Export a single secret store by id. The response can be saved to file as is.

    Parameters

    • secretStoreId: string

      Secret store id
    • globalConfig: boolean

      true if global secret store is the target of the operation, false otherwise. Default: false.

    Returns Promise<SecretStoreExportInterface>

    Promise resolving to a SecretStoreExportInterface object.

• exportSecretStores:function

  • exportSecretStores(globalConfig: boolean): Promise<SecretStoreExportInterface>

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

    Parameters

    • globalConfig: boolean

      true if global secret stores are the target of the operation, false otherwise. Default: false.

    Returns Promise<SecretStoreExportInterface>

    Promise resolving to a SecretStoreExportInterface object.

• importSecretStores:function

  • importSecretStores(
        importData: SecretStoreExportInterface,
        globalConfig: boolean,
        secretStoreId?: string,
    ): Promise<SecretStoreExportSkeleton[]>

    Import secret stores and mappings

    Parameters

    • importData: SecretStoreExportInterface

      secret store import data
    • globalConfig: boolean

      true if the secret store mapping is global, false otherwise. Default: false.
    • OptionalsecretStoreId: string

      optional secret store id. If supplied, only the secret store of that id is imported.

    Returns Promise<SecretStoreExportSkeleton[]>

    the imported secret stores and mappings

• readSecretStore:function

  • readSecretStore(
        secretStoreId: string,
        globalConfig: boolean,
    ): Promise<AmConfigEntityInterface>

    Read secret store by id

    Parameters

    • secretStoreId: string

      Secret store id
    • globalConfig: boolean

      true if global secret store is the target of the operation, false otherwise. Default: false.

    Returns Promise<AmConfigEntityInterface>

    a promise that resolves to a secret store object

• readSecretStoreMappings:function

  • readSecretStoreMappings(
        secretStoreId: string,
        secretStoreTypeId: string,
        globalConfig: boolean,
    ): Promise<SecretStoreMappingSkeleton[]>

    Read secret store mappings

    Parameters

    • secretStoreId: string

      Secret store id
    • secretStoreTypeId: string

      Secret store type id
    • globalConfig: boolean

      true if the secret store is global, false otherwise. Default: false.

    Returns Promise<SecretStoreMappingSkeleton[]>

    a promise that resolves to an array of secret store mapping objects

• readSecretStores:function

  • readSecretStores(globalConfig: boolean): Promise<AmConfigEntityInterface[]>

    Read all secret stores.

    Parameters

    • globalConfig: boolean

      true if global secret stores are the target of the operation, false otherwise. Default: false.

    Returns Promise<AmConfigEntityInterface[]>

    a promise that resolves to an array of secret store objects

• updateSecretStore:function

  • updateSecretStore(
        secretStoreData: AmConfigEntityInterface,
        globalConfig: boolean,
    ): Promise<AmConfigEntityInterface>

    Update secret store

    Parameters

    • secretStoreData: AmConfigEntityInterface

      secret store to import
    • globalConfig: boolean

      true if the secret store is global, false otherwise. Default: false.

    Returns Promise<AmConfigEntityInterface>

    a promise that resolves to a secret store object

• updateSecretStoreMapping:function

  • updateSecretStoreMapping(
        secretStoreId: string,
        secretStoreTypeId: string,
        secretStoreMappingData: SecretStoreMappingSkeleton,
        globalConfig: boolean,
    ): Promise<SecretStoreMappingSkeleton>

    Update secret store mapping

    Parameters

    • secretStoreId: string

      Secret store id
    • secretStoreTypeId: string

      Secret store type id
    • secretStoreMappingData: SecretStoreMappingSkeleton

      secret store mapping to import
    • globalConfig: boolean

      true if the secret store mapping is global, false otherwise. Default: false.

    Returns Promise<SecretStoreMappingSkeleton>

    a promise that resolves to a secret store mapping object