Type Alias SecretStore

Type declaration

• canSecretStoreHaveMappings:function

  • canSecretStoreHaveMappings(secretStoreTypeId: string): boolean

    Function that returns true if the given secret store type can have mappings, false otherwise

    Parameters

    • secretStoreTypeId: string

      The secret store type

    Returns boolean

    true if the given secret store type can have mappings, false otherwise

• createSecretStoreExportTemplate:function

  • createSecretStoreExportTemplate(): SecretStoreExportInterface

    Create an empty secret store export template

    Returns SecretStoreExportInterface

    an empty secret store export template

• createSecretStoreMapping:function

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

    Create secret store mapping. Will throw if type is not defined and multiple secret stores with the same id are found.

    Parameters

    • secretStoreId: string

      Secret store id
    • secretStoreTypeId: string

      Secret store type id (optional)
    • secretStoreMappingData: SecretStoreMappingSkeleton

      The secret store mapping data,
    • globalConfig: boolean

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

    Returns Promise<SecretStoreMappingSkeleton>

    a promise that resolves to a secret store mapping object of the mapping created

• deleteSecretStore:function

  • deleteSecretStore(
        secretStoreId: string,
        secretStoreTypeId: string,
        globalConfig: boolean,
    ): Promise<SecretStoreSkeleton>

    Delete secret store by id

    Parameters

    • secretStoreId: string

      Secret store id
    • secretStoreTypeId: string

      Secret store type id (optional)
    • globalConfig: boolean

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

    Returns Promise<SecretStoreSkeleton>

    a promise that resolves to a secret store object

• deleteSecretStoreMapping:function

  • deleteSecretStoreMapping(
        secretStoreId: string,
        secretStoreTypeId: string,
        secretId: string,
        globalConfig: boolean,
    ): Promise<SecretStoreMappingSkeleton>

    Delete secret store mapping

    Parameters

    • secretStoreId: string

      Secret store id
    • secretStoreTypeId: string

      Secret store type id (optional)
    • secretId: string

      Secret store mapping label
    • 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

• deleteSecretStoreMappings:function

  • deleteSecretStoreMappings(
        secretStoreId: string,
        secretStoreTypeId: string,
        globalConfig: boolean,
        resultCallback?: ResultCallback<SecretStoreMappingSkeleton>,
    ): Promise<SecretStoreMappingSkeleton[]>

    Delete secret store mappings

    Parameters

    • secretStoreId: string

      Secret store id
    • secretStoreTypeId: string

      Secret store type id (optional)
    • globalConfig: boolean

      true if the secret store mapping is global, false otherwise. Default: false.
    • OptionalresultCallback: ResultCallback<SecretStoreMappingSkeleton>

      Optional callback to process individual results

    Returns Promise<SecretStoreMappingSkeleton[]>

    a promise that resolves to a secret store mapping object

• deleteSecretStores:function

  • deleteSecretStores(
        globalConfig: boolean,
        resultCallback?: ResultCallback<SecretStoreSkeleton>,
    ): Promise<SecretStoreSkeleton[]>

    Delete all secret stores

    Parameters

    • globalConfig: boolean

      true if the secret store mappings are global, false otherwise. Default: false.
    • OptionalresultCallback: ResultCallback<SecretStoreSkeleton>

      Optional callback to process individual results

    Returns Promise<SecretStoreSkeleton[]>

    a promise that resolves to an array of secret store objects

• exportSecretStore:function

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

    Export a single secret store by id. The response can be saved to file as is. Will throw if type is not defined and multiple secret stores with the same id are found.

    Parameters

    • secretStoreId: string

      Secret store id
    • secretStoreTypeId: string

      Secret store type id (optional)
    • 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,
        resultCallback?: ResultCallback<SecretStoreSkeleton>,
    ): 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.
    • OptionalresultCallback: ResultCallback<SecretStoreSkeleton>

      Optional callback to process individual results

    Returns Promise<SecretStoreExportInterface>

    Promise resolving to a SecretStoreExportInterface object.

• importSecretStores:function

  • importSecretStores(
        importData: SecretStoreExportInterface,
        globalConfig: boolean,
        secretStoreId?: string,
        secretStoreTypeId?: string,
        resultCallback?: ResultCallback<SecretStoreSkeleton>,
    ): 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.
    • OptionalsecretStoreTypeId: string

      optional secret store type id
    • OptionalresultCallback: ResultCallback<SecretStoreSkeleton>

      Optional callback to process individual results

    Returns Promise<SecretStoreExportSkeleton[]>

    the imported secret stores and mappings

• readSecretStore:function

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

    Read secret store by id. Will throw if type is not defined and multiple secret stores with the same id are found.

    Parameters

    • secretStoreId: string

      Secret store id
    • secretStoreTypeId: string

      Secret store type id (optional)
    • globalConfig: boolean

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

    Returns Promise<SecretStoreSkeleton>

    a promise that resolves to a secret store object

• readSecretStoreMapping:function

  • readSecretStoreMapping(
        secretStoreId: string,
        secretStoreTypeId: string,
        secretId: string,
        globalConfig: boolean,
    ): Promise<SecretStoreMappingSkeleton>

    Read secret store mapping. Will throw if type is not defined and multiple secret stores with the same id are found.

    Parameters

    • secretStoreId: string

      Secret store id
    • secretStoreTypeId: string

      Secret store type id (optional)
    • secretId: string

      Secret store mapping label
    • 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

• readSecretStoreMappings:function

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

    Read secret store mappings. Will throw if type is not defined and multiple secret stores with the same id are found.

    Parameters

    • secretStoreId: string

      Secret store id
    • secretStoreTypeId: string

      Secret store type id (optional)
    • 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<SecretStoreSkeleton[]>

    Read all secret stores.

    Parameters

    • globalConfig: boolean

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

    Returns Promise<SecretStoreSkeleton[]>

    a promise that resolves to an array of secret store objects

• readSecretStoreSchema:function

  • readSecretStoreSchema(
        secretStoreTypeId: string,
        globalConfig: boolean,
    ): Promise<SecretStoreSchemaSkeleton>

    Read secret store schema

    Parameters

    • secretStoreTypeId: string

      Secret store type id
    • globalConfig: boolean

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

    Returns Promise<SecretStoreSchemaSkeleton>

    a promise that resolves to a secret store schema object

• updateSecretStore:function

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

    Update secret store

    Parameters

    • secretStoreData: SecretStoreSkeleton

      secret store to import
    • globalConfig: boolean

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

    Returns Promise<SecretStoreSkeleton>

    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. Will throw if type is not defined and multiple secret stores with the same id are found.

    Parameters

    • secretStoreId: string

      Secret store id
    • secretStoreTypeId: string

      Secret store type id (optional)
    • 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