Liking cljdoc? Tell your friends :D

clj-oci.vault.versions

OCI Vault Secret Management API — SecretVersion sub-resource (4 operations).

This namespace wraps the SecretVersion ops on VaultsClient. Sub-resource of Secret (path: /secrets/{secretId}/version/{versionNumber}); operations work against a specific version of an existing secret.

Operations: get-secret-version, list-secret-versions, schedule-secret-version-deletion, cancel-secret-version-deletion.

Region-aware via clients/vaults-client-for. Same precedence as vault.secrets.

Javadocs: https://docs.oracle.com/en-us/iaas/tools/java/3.86.0/

OCI Vault Secret Management API — SecretVersion sub-resource (4 operations).

This namespace wraps the SecretVersion ops on `VaultsClient`. Sub-resource
of Secret (path: `/secrets/{secretId}/version/{versionNumber}`); operations
work against a specific version of an existing secret.

Operations:
  get-secret-version, list-secret-versions,
  schedule-secret-version-deletion, cancel-secret-version-deletion.

Region-aware via `clients/vaults-client-for`. Same precedence as
`vault.secrets`.

Javadocs: https://docs.oracle.com/en-us/iaas/tools/java/3.86.0/
raw docstring

cancel-secret-version-deletionclj

(cancel-secret-version-deletion secret-id version-number)
(cancel-secret-version-deletion secret-id version-number opts)

Cancels the scheduled deletion of a SecretVersion.

Returns {:data {}} (204) or {:error ...}.

Required: secret-id, version-number (long, ≥ 1). Options: :region.

Cancels the scheduled deletion of a SecretVersion.

Returns `{:data {}}` (204) or `{:error ...}`.

Required: `secret-id`, `version-number` (long, ≥ 1).
Options: `:region`.
raw docstring

get-secret-versionclj

(get-secret-version secret-id version-number)
(get-secret-version secret-id version-number opts)

Gets a specific SecretVersion.

Returns {:data {:secretVersion <map>}} or {:error ...}. The map excludes secret contents (use clj-oci.secrets/get-secret-bundle for the decrypted value).

Required: secret-id, version-number (long, ≥ 1). Options: :region.

Gets a specific SecretVersion.

Returns `{:data {:secretVersion <map>}}` or `{:error ...}`. The map
excludes secret contents (use `clj-oci.secrets/get-secret-bundle` for the
decrypted value).

Required: `secret-id`, `version-number` (long, ≥ 1).
Options: `:region`.
raw docstring

list-secret-versionsclj

(list-secret-versions secret-id)
(list-secret-versions secret-id opts)

Lists all SecretVersions for secret-id, paginating automatically.

Returns {:data {:items [version-summary-maps...]}} or {:error ...}. Each map carries: :secretId, :versionNumber, :versionName, :stages (list of stage keywords/enums), :contentType, :isContentAutoGenerated, :timeCreated, :timeOfDeletion, :timeOfExpiry, :systemTags.

Options: :region — region-id or 3-letter code :sort-by — :version-number (default DESC) :sort-order — :asc or :desc :limit — page size (default 100)

Lists all SecretVersions for `secret-id`, paginating automatically.

Returns `{:data {:items [version-summary-maps...]}}` or `{:error ...}`.
Each map carries: `:secretId`, `:versionNumber`, `:versionName`, `:stages`
(list of stage keywords/enums), `:contentType`, `:isContentAutoGenerated`,
`:timeCreated`, `:timeOfDeletion`, `:timeOfExpiry`, `:systemTags`.

Options:
  :region     — region-id or 3-letter code
  :sort-by    — `:version-number` (default DESC)
  :sort-order — `:asc` or `:desc`
  :limit      — page size (default 100)
raw docstring

schedule-secret-version-deletionclj

(schedule-secret-version-deletion secret-id version-number)
(schedule-secret-version-deletion secret-id version-number opts)

Schedules deletion of a specific SecretVersion.

The version MUST be in Deprecated stage — server returns 409 otherwise.

Returns {:data {}} (204) or {:error ...}.

Required: secret-id, version-number (long, ≥ 1). Options: :timeOfDeletion — java.util.Date; server applies default if omitted :region — region-id or 3-letter code

Schedules deletion of a specific SecretVersion.

The version MUST be in `Deprecated` stage — server returns 409 otherwise.

Returns `{:data {}}` (204) or `{:error ...}`.

Required: `secret-id`, `version-number` (long, ≥ 1).
Options:
  :timeOfDeletion — java.util.Date; server applies default if omitted
  :region         — region-id or 3-letter code
raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close