Liking cljdoc? Tell your friends :D

clj-oci.organizations.organization

OCI Organizations API — Organization resource (Tenant Manager Control Plane).

Three control-plane ops on the Organization resource itself:

  • get-organization — fetch one Organization by OCID
  • list-organizations — list Organizations in a compartment (paginated)
  • update-organization — set defaultUcmSubscriptionId (async, returns workReqId)

The Organizations service is regional (43 endpoints). All ops route via clients/organization-client-for, which resolves the region from (:region opts) > the organization OCID's region segment > the singleton default. ListOrganizations takes a compartment OCID (no region segment) so it falls back to :region opt or the singleton.

Note: oci/http-request discards response headers, so this namespace accepts :if-match outbound but cannot surface etag or opc-request-id inbound — same limitation as compute.clj and generative_ai.clj.

OCI Organizations API — Organization resource (Tenant Manager Control Plane).

Three control-plane ops on the Organization resource itself:

- `get-organization`    — fetch one Organization by OCID
- `list-organizations`  — list Organizations in a compartment (paginated)
- `update-organization` — set `defaultUcmSubscriptionId` (async, returns workReqId)

The Organizations service is regional (43 endpoints). All ops route via
`clients/organization-client-for`, which resolves the region from
`(:region opts)` > the organization OCID's region segment > the singleton
default. ListOrganizations takes a compartment OCID (no region segment) so
it falls back to `:region` opt or the singleton.

Note: `oci/http-request` discards response headers, so this namespace
accepts `:if-match` outbound but cannot surface `etag` or `opc-request-id`
inbound — same limitation as `compute.clj` and `generative_ai.clj`.
raw docstring

get-organizationclj

(get-organization organization-id)
(get-organization organization-id opts)

Fetches a single Organization by OCID.

Returns {:data {...}} or {:error ...}.

The region is resolved from (:region opts) > the OCID's region segment

the singleton default.

Fetches a single Organization by OCID.

Returns `{:data {...}}` or `{:error ...}`.

The region is resolved from `(:region opts)` > the OCID's region segment
> the singleton default.
raw docstring

list-organizationsclj

(list-organizations compartment-id)
(list-organizations compartment-id opts)

Lists Organizations in compartment-id, paginating automatically.

Returns {:data {:items [organization-maps...]}} or {:error ...}.

Options: :region — region-id or 3-letter code (defaults to the singleton's region) :limit — page size (default 100; max 1000)

Lists Organizations in `compartment-id`, paginating automatically.

Returns `{:data {:items [organization-maps...]}}` or `{:error ...}`.

Options:
  :region — region-id or 3-letter code (defaults to the singleton's region)
  :limit  — page size (default 100; max 1000)
raw docstring

update-organizationclj

(update-organization organization-id details)
(update-organization organization-id details opts)

Updates the Organization's defaultUcmSubscriptionId (async).

Returns {:data {:opcWorkRequestId "..."}} or {:error ...}. The work-request polling API is not wrapped in this slice; callers query externally if they need to wait.

details map: :default-ucm-subscription-id (required).

Options: :region — region-id or 3-letter code :if-match — etag for optimistic concurrency :opc-retry-token — idempotency token (expires after 24h)

Updates the Organization's `defaultUcmSubscriptionId` (async).

Returns `{:data {:opcWorkRequestId "..."}}` or `{:error ...}`. The
work-request polling API is not wrapped in this slice; callers query
externally if they need to wait.

`details` map: `:default-ucm-subscription-id` (required).

Options:
  :region          — region-id or 3-letter code
  :if-match        — etag for optimistic concurrency
  :opc-retry-token — idempotency token (expires after 24h)
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