Liking cljdoc? Tell your friends :D

clj-oci.vault.secrets

OCI Vault Secret Management API — Secret resource (9 operations).

This namespace wraps the VaultsClient SDK class (Maven artifact oci-java-sdk-vault). The Vault Management API endpoint is vaults.<region>.oci.oraclecloud.com (path version /20180608); it is distinct from the Vault Retrieval API (secrets.vaults.<region>..., wrapped by clj-oci.secrets).

Operations: list-secrets, get-secret, create-secret, update-secret, schedule-secret-deletion, cancel-secret-deletion, change-secret-compartment, rotate-secret, cancel-secret-rotation.

Polymorphic body fields (secretContent, secretGenerationContext, secretRules, rotationConfig) are constructed via per-subclass helpers in clj-oci.vault.types, then passed pre-built through the params map.

The service is regional. Operations route via clients/vaults-client-for-region with the usual precedence: (:region opts) > OCID region segment > singleton's default.

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

OCI Vault Secret Management API — Secret resource (9 operations).

This namespace wraps the `VaultsClient` SDK class (Maven artifact
`oci-java-sdk-vault`). The Vault Management API endpoint is
`vaults.<region>.oci.oraclecloud.com` (path version `/20180608`); it is
distinct from the Vault Retrieval API (`secrets.vaults.<region>...`,
wrapped by `clj-oci.secrets`).

Operations:
  list-secrets, get-secret, create-secret, update-secret,
  schedule-secret-deletion, cancel-secret-deletion,
  change-secret-compartment, rotate-secret, cancel-secret-rotation.

Polymorphic body fields (`secretContent`, `secretGenerationContext`,
`secretRules`, `rotationConfig`) are constructed via per-subclass helpers
in `clj-oci.vault.types`, then passed pre-built through the params map.

The service is regional. Operations route via
`clients/vaults-client-for-region` with the usual precedence:
(:region opts) > OCID region segment > singleton's default.

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

clj-oci.vault.types

Polymorphic builders + supporting enum maps for the OCI Vault Secret Management API.

This module is the shared foundation for clj-oci.vault.secrets and clj-oci.vault.versions. It does NOT make SDK calls — it produces Java model instances that those modules pass into builder/to-java when constructing request bodies.

The Vault SDK has four polymorphic base classes with Jackson-style discriminators, plus one non-polymorphic composer (RotationConfig) that contains a polymorphic field:

SecretContentDetails — Base64SecretContentDetails SecretGenerationContext — Bytes / Passphrase / SshKey GenerationContext SecretRule — SecretExpiryRule, SecretReuseRule TargetSystemDetails — Adb / Function TargetSystemDetails RotationConfig — contains TargetSystemDetails

Per the clj-oci convention (see CLAUDE.md), oci-build does NOT auto-dispatch on a discriminator key. Each concrete subclass has its own tiny helper that wraps builder/to-java for that concrete builder; the downstream composer (create-secret, update-secret) accepts the pre-built Java instance and assembles the request.

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

Polymorphic builders + supporting enum maps for the OCI Vault Secret
Management API.

This module is the shared foundation for `clj-oci.vault.secrets` and
`clj-oci.vault.versions`. It does NOT make SDK calls — it produces Java
model instances that those modules pass into `builder/to-java` when
constructing request bodies.

The Vault SDK has four polymorphic base classes with Jackson-style
discriminators, plus one non-polymorphic composer (`RotationConfig`)
that contains a polymorphic field:

  SecretContentDetails    — Base64SecretContentDetails
  SecretGenerationContext — Bytes / Passphrase / SshKey GenerationContext
  SecretRule              — SecretExpiryRule, SecretReuseRule
  TargetSystemDetails     — Adb / Function TargetSystemDetails
  RotationConfig          — contains TargetSystemDetails

Per the clj-oci convention (see CLAUDE.md), `oci-build` does NOT
auto-dispatch on a discriminator key. Each concrete subclass has its own
tiny helper that wraps `builder/to-java` for that concrete builder; the
downstream composer (`create-secret`, `update-secret`) accepts the pre-built
Java instance and assembles the request.

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

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

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