Class Secrets

Hierarchy

Constructors

constructor

Methods

create delete edit info list

Constructors

constructor

Methods

create

  • create(secretObj): Promise<{
        id: string;
    }>

  • Create a new secret

    Parameters

    Returns Promise<{
        id: string;
    }>

delete

  • delete(secretID): Promise<string>

  • Deletes a secret from the account

    Parameters

    • secretID: string

      Secret identification

    Returns Promise<string>

edit

  • edit(secretID, secretObj): Promise<string>

  • Modify any property of the secret.

    Parameters

    • secretID: string

      Secret identification

    • secretObj: Partial<Pick<SecretsInfo, "tags"> & SecretsValue>

      Secret Object with data to replace

    Returns Promise<string>

info

list

  • list(queryObj?): Promise<SecretsInfo[]>

  • Retrieves a list with all Secrets from the profile

    Parameters

    Returns Promise<SecretsInfo[]>

    Default

    queryObj: {
      page: 1,
      fields: ["id", "key"],
      filter: {},
      amount: 20,
      orderBy: "key,asc",
    }
    ```json

Settings

Member Visibility

Theme

On This Page

constructorcreatedeleteeditinfolist