Class API

constructor

• new API(client: Client): Secret.v1beta1.API

• Parameters

  • client: Client

  Returns Secret.v1beta1.API

Static ReadonlyLOCALITIES

accessSecretVersion

• accessSecretVersion(
      request: Readonly<Secret.v1beta1.AccessSecretVersionRequest>,
  ): Promise<Secret.v1beta1.AccessSecretVersionResponse>

• Access a secret's version using the secret's ID. Access sensitive data in a secret's version specified by the region, secret_id and revision parameters.

  Parameters

  • request: Readonly<Secret.v1beta1.AccessSecretVersionRequest>

    The request AccessSecretVersionRequest

  Returns Promise<Secret.v1beta1.AccessSecretVersionResponse>

  A Promise of AccessSecretVersionResponse

accessSecretVersionByPath

• accessSecretVersionByPath(
      request: Readonly<AccessSecretVersionByPathRequest>,
  ): Promise<Secret.v1beta1.AccessSecretVersionResponse>

• Access a secret's version using the secret's name and path. Access sensitive data in a secret's version specified by the region, secret_name, secret_path and revision parameters.

  Parameters

  • request: Readonly<AccessSecretVersionByPathRequest>

    The request AccessSecretVersionByPathRequest

  Returns Promise<Secret.v1beta1.AccessSecretVersionResponse>

  A Promise of AccessSecretVersionResponse

addSecretOwner

• addSecretOwner(
      request: Readonly<Secret.v1beta1.AddSecretOwnerRequest>,
  ): Promise<void>

• Allow a product to use the secret.

  Parameters

  • request: Readonly<Secret.v1beta1.AddSecretOwnerRequest>

    The request AddSecretOwnerRequest

  Returns Promise<void>

browseSecrets

• browseSecrets(
      request: Readonly<BrowseSecretsRequest>,
  ): Promise<BrowseSecretsResponse>

• Browse secrets. Retrieve the list of secrets and folders for the given prefix. You must specify either the organization_id or the project_id and the region.

  Parameters

  • request: Readonly<BrowseSecretsRequest>

    The request BrowseSecretsRequest

  Returns Promise<BrowseSecretsResponse>

  A Promise of BrowseSecretsResponse

createSecret

• createSecret(
      request: Readonly<Secret.v1beta1.CreateSecretRequest>,
  ): Promise<Secret.v1beta1.Secret>

• Create a secret. Create a secret in a given region specified by the region parameter.

  Parameters

  • request: Readonly<Secret.v1beta1.CreateSecretRequest>

    The request CreateSecretRequest

  Returns Promise<Secret.v1beta1.Secret>

  A Promise of Secret

createSecretVersion

• createSecretVersion(
      request: Readonly<Secret.v1beta1.CreateSecretVersionRequest>,
  ): Promise<Secret.v1beta1.SecretVersion>

• Create a version. Create a version of a given secret specified by the region and secret_id parameters.

  Parameters

  • request: Readonly<Secret.v1beta1.CreateSecretVersionRequest>

    The request CreateSecretVersionRequest

  Returns Promise<Secret.v1beta1.SecretVersion>

  A Promise of SecretVersion

deleteSecret

• deleteSecret(
      request: Readonly<Secret.v1beta1.DeleteSecretRequest>,
  ): Promise<void>

• Delete a secret. Delete a given secret specified by the region and secret_id parameters.

  Parameters

  • request: Readonly<Secret.v1beta1.DeleteSecretRequest>

    The request DeleteSecretRequest

  Returns Promise<void>

deleteSecretVersion

• deleteSecretVersion(
      request: Readonly<DeleteSecretVersionRequest>,
  ): Promise<void>

• Delete a version. Delete a secret's version and the sensitive data contained in it. Deleting a version is permanent and cannot be undone.

  Parameters

  • request: Readonly<DeleteSecretVersionRequest>

    The request DeleteSecretVersionRequest

  Returns Promise<void>

disableSecretVersion

• disableSecretVersion(
      request: Readonly<Secret.v1beta1.DisableSecretVersionRequest>,
  ): Promise<Secret.v1beta1.SecretVersion>

• Disable a version. Make a specific version inaccessible. You must specify the region, secret_id and revision parameters.

  Parameters

  • request: Readonly<Secret.v1beta1.DisableSecretVersionRequest>

    The request DisableSecretVersionRequest

  Returns Promise<Secret.v1beta1.SecretVersion>

  A Promise of SecretVersion

enableSecretVersion

• enableSecretVersion(
      request: Readonly<Secret.v1beta1.EnableSecretVersionRequest>,
  ): Promise<Secret.v1beta1.SecretVersion>

• Enable a version. Make a specific version accessible. You must specify the region, secret_id and revision parameters.

  Parameters

  • request: Readonly<Secret.v1beta1.EnableSecretVersionRequest>

    The request EnableSecretVersionRequest

  Returns Promise<Secret.v1beta1.SecretVersion>

  A Promise of SecretVersion

getSecret

• getSecret(
      request: Readonly<Secret.v1beta1.GetSecretRequest>,
  ): Promise<Secret.v1beta1.Secret>

• Get metadata using the secret's ID. Retrieve the metadata of a secret specified by the region and secret_id parameters.

  Parameters

  • request: Readonly<Secret.v1beta1.GetSecretRequest>

    The request GetSecretRequest

  Returns Promise<Secret.v1beta1.Secret>

  A Promise of Secret

getSecretVersion

• getSecretVersion(
      request: Readonly<Secret.v1beta1.GetSecretVersionRequest>,
  ): Promise<Secret.v1beta1.SecretVersion>

• Get metadata of a secret's version using the secret's ID. Retrieve the metadata of a secret's given version specified by the region, secret_id and revision parameters.

  Parameters

  • request: Readonly<Secret.v1beta1.GetSecretVersionRequest>

    The request GetSecretVersionRequest

  Returns Promise<Secret.v1beta1.SecretVersion>

  A Promise of SecretVersion

listSecrets

• listSecrets(
      request: Readonly<Secret.v1beta1.ListSecretsRequest>,
  ): Promise<Secret.v1beta1.ListSecretsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Secret.v1beta1.Secret[],
          void,
          void,
      >;
      all: () => Promise<Secret.v1beta1.Secret[]>;
  }

• List secrets. Retrieve the list of secrets created within an Organization and/or Project. You must specify either the organization_id or the project_id and the region.

  Parameters

  • request: Readonly<Secret.v1beta1.ListSecretsRequest>

    The request ListSecretsRequest

  Returns Promise<Secret.v1beta1.ListSecretsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Secret.v1beta1.Secret[],
          void,
          void,
      >;
      all: () => Promise<Secret.v1beta1.Secret[]>;
  }

  A Promise of ListSecretsResponse

listSecretTypes

• listSecretTypes(
      request?: Readonly<ListSecretTypesRequest>,
  ): Promise<ListSecretTypesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Secret.v1beta1.SecretType[],
          void,
          void,
      >;
      all: () => Promise<Secret.v1beta1.SecretType[]>;
  }

• List secret types. List all secret types created within a given Project.

  Parameters

  • request: Readonly<ListSecretTypesRequest> = {}

    The request ListSecretTypesRequest

  Returns Promise<ListSecretTypesResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Secret.v1beta1.SecretType[],
          void,
          void,
      >;
      all: () => Promise<Secret.v1beta1.SecretType[]>;
  }

  A Promise of ListSecretTypesResponse

listSecretVersions

• listSecretVersions(
      request: Readonly<Secret.v1beta1.ListSecretVersionsRequest>,
  ): Promise<Secret.v1beta1.ListSecretVersionsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Secret.v1beta1.SecretVersion[],
          void,
          void,
      >;
      all: () => Promise<Secret.v1beta1.SecretVersion[]>;
  }

• List versions of a secret using the secret's ID. Retrieve the list of a given secret's versions specified by the secret_id and region parameters.

  Parameters

  • request: Readonly<Secret.v1beta1.ListSecretVersionsRequest>

    The request ListSecretVersionsRequest

  Returns Promise<Secret.v1beta1.ListSecretVersionsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          Secret.v1beta1.SecretVersion[],
          void,
          void,
      >;
      all: () => Promise<Secret.v1beta1.SecretVersion[]>;
  }

  A Promise of ListSecretVersionsResponse

listTags

• listTags(
      request?: Readonly<Secret.v1beta1.ListTagsRequest>,
  ): Promise<Secret.v1beta1.ListTagsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<string[], void, void>;
      all: () => Promise<string[]>;
  }

• List tags. List all tags associated with secrets within a given Project.

  Parameters

  • request: Readonly<Secret.v1beta1.ListTagsRequest> = {}

    The request ListTagsRequest

  Returns Promise<Secret.v1beta1.ListTagsResponse> & {
      "[asyncIterator]": () => AsyncGenerator<string[], void, void>;
      all: () => Promise<string[]>;
  }

  A Promise of ListTagsResponse

protectSecret

• protectSecret(
      request: Readonly<Secret.v1beta1.ProtectSecretRequest>,
  ): Promise<Secret.v1beta1.Secret>

• Enable secret protection. Enable secret protection for a given secret specified by the secret_id parameter. Enabling secret protection means that your secret can be read and modified, but it cannot be deleted.

  Parameters

  • request: Readonly<Secret.v1beta1.ProtectSecretRequest>

    The request ProtectSecretRequest

  Returns Promise<Secret.v1beta1.Secret>

  A Promise of Secret

restoreSecret

• restoreSecret(
      request: Readonly<RestoreSecretRequest>,
  ): Promise<Secret.v1beta1.Secret>

• Restore a secret. Restore a secret and all its versions scheduled for deletion specified by the region and secret_id parameters.

  Parameters

  • request: Readonly<RestoreSecretRequest>

    The request RestoreSecretRequest

  Returns Promise<Secret.v1beta1.Secret>

  A Promise of Secret

restoreSecretVersion

• restoreSecretVersion(
      request: Readonly<RestoreSecretVersionRequest>,
  ): Promise<Secret.v1beta1.SecretVersion>

• Restore a version. Restore a secret's version specified by the region, secret_id and revision parameters.

  Parameters

  • request: Readonly<RestoreSecretVersionRequest>

    The request RestoreSecretVersionRequest

  Returns Promise<Secret.v1beta1.SecretVersion>

  A Promise of SecretVersion

unprotectSecret

• unprotectSecret(
      request: Readonly<Secret.v1beta1.UnprotectSecretRequest>,
  ): Promise<Secret.v1beta1.Secret>

• Disable secret protection. Disable secret protection for a given secret specified by the secret_id parameter. Disabling secret protection means that your secret can be read, modified and deleted.

  Parameters

  • request: Readonly<Secret.v1beta1.UnprotectSecretRequest>

    The request UnprotectSecretRequest

  Returns Promise<Secret.v1beta1.Secret>

  A Promise of Secret

updateSecret

• updateSecret(
      request: Readonly<Secret.v1beta1.UpdateSecretRequest>,
  ): Promise<Secret.v1beta1.Secret>

• Update metadata of a secret. Edit a secret's metadata such as name, tag(s), description and ephemeral policy. The secret to update is specified by the secret_id and region parameters.

  Parameters

  • request: Readonly<Secret.v1beta1.UpdateSecretRequest>

    The request UpdateSecretRequest

  Returns Promise<Secret.v1beta1.Secret>

  A Promise of Secret

updateSecretVersion

• updateSecretVersion(
      request: Readonly<Secret.v1beta1.UpdateSecretVersionRequest>,
  ): Promise<Secret.v1beta1.SecretVersion>

• Update metadata of a version. Edit the metadata of a secret's given version, specified by the region, secret_id and revision parameters.

  Parameters

  • request: Readonly<Secret.v1beta1.UpdateSecretVersionRequest>

    The request UpdateSecretVersionRequest

  Returns Promise<Secret.v1beta1.SecretVersion>

  A Promise of SecretVersion