@squidcloud/client
    Preparing search index...

    Class SecretClient

    SecretClient provides methods for managing secrets, including retrieval, update, and deletion of stored secrets and API keys.

    Index

    Accessors

    Methods

    • Deletes a specified secret key. If the secret is missing, it will be ignored, and the operation will proceed without failure.

      Parameters

      • key: string

        The secret key to delete.

      • force: boolean = false

        If set to true, forces deletion regardless of the secret's usage status across any enabled integrations. Default is false.

      Returns Promise<void>

      A promise that resolves when the deletion request is complete.

    • Deletes a list of specified secret keys. If any secret in the list is missing, it will be ignored, and the operation will proceed without failure.

      Parameters

      • keys: string[]

        An array of secret keys to delete.

      • force: boolean = false

        If set to true, forces deletion regardless of the secret's usage status across any enabled integrations. Default is false.

      Returns Promise<void>

      A promise that resolves when the deletion request is complete.

    • Retrieves a stored custom secret by its key.

      Parameters

      • key: string

        The key of the secret to retrieve.

      Returns Promise<undefined | SecretEntry<SecretValue>>

      A promise resolving to the secret entry if found, or undefined if not found.

    • Retrieves all stored custom secrets.

      Returns Promise<Record<string, SecretEntry<SecretValue>>>

      A promise resolving to a record of secret entries keyed by their secret keys.