Liking cljdoc? Tell your friends :D

clj-oci.organizations.tenancies

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

Six ops on tenancies that belong to an organization, all served by OrganizationClient:

  • list-organization-tenancies — list children of an organization (paginated)
  • get-organization-tenancy — fetch one OrganizationTenancy
  • approve-organization-tenancy-for-transfer — approve a child for transfer (sync, returns OT)
  • unapprove-organization-tenancy-for-transfer — cancel a transfer approval (sync, returns OT)
  • delete-organization-tenancy — start tenancy termination (async, returns workReqId)
  • restore-organization-tenancy — restore a deleted tenancy (async, returns workReqId)

Region resolution mirrors the rest of the Organizations namespace tree: (:region opts) > OCID-derived > singleton default.

Note the path-param naming asymmetry across ops: get-organization-tenancy uses tenancyId while sibling action ops use organizationTenancyId for what is effectively the same OCID. The wrapper accepts a single organization-tenancy-id string and routes it to whichever Java field the SDK method actually requires.

Async ops surface :opcWorkRequestId in :data; the work-request polling API is not wrapped in this slice.

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

Six ops on tenancies that belong to an organization, all served by
`OrganizationClient`:

- `list-organization-tenancies`         — list children of an organization (paginated)
- `get-organization-tenancy`            — fetch one OrganizationTenancy
- `approve-organization-tenancy-for-transfer`   — approve a child for transfer (sync, returns OT)
- `unapprove-organization-tenancy-for-transfer` — cancel a transfer approval (sync, returns OT)
- `delete-organization-tenancy`         — start tenancy termination (async, returns workReqId)
- `restore-organization-tenancy`        — restore a deleted tenancy (async, returns workReqId)

Region resolution mirrors the rest of the Organizations namespace tree:
`(:region opts)` > OCID-derived > singleton default.

Note the path-param naming asymmetry across ops: `get-organization-tenancy`
uses `tenancyId` while sibling action ops use `organizationTenancyId` for
what is effectively the same OCID. The wrapper accepts a single
`organization-tenancy-id` string and routes it to whichever Java field the
SDK method actually requires.

Async ops surface `:opcWorkRequestId` in `:data`; the work-request polling
API is not wrapped in this slice.
raw docstring

approve-organization-tenancy-for-transferclj

(approve-organization-tenancy-for-transfer compartment-id
                                           organization-tenancy-id)
(approve-organization-tenancy-for-transfer compartment-id
                                           organization-tenancy-id
                                           opts)

Approves an organization's child tenancy for transfer to another organization (sync). Returns the updated OrganizationTenancy resource.

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

compartment-id is required by the SDK and is the tenancy OCID under which the operation is recorded.

Options: :region — region-id or 3-letter code :if-match — etag for optimistic concurrency :opc-retry-token — idempotency token

Approves an organization's child tenancy for transfer to another
organization (sync). Returns the updated OrganizationTenancy resource.

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

`compartment-id` is required by the SDK and is the tenancy OCID under
which the operation is recorded.

Options:
  :region          — region-id or 3-letter code
  :if-match        — etag for optimistic concurrency
  :opc-retry-token — idempotency token
raw docstring

delete-organization-tenancyclj

(delete-organization-tenancy organization-tenancy-id)
(delete-organization-tenancy organization-tenancy-id opts)

Initiates termination of an organization's child tenancy after server-side validation (async).

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

Initiates termination of an organization's child tenancy after
server-side validation (async).

Returns `{:data {:opcWorkRequestId "..."}}` or `{:error ...}`.
raw docstring

get-organization-tenancyclj

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

Fetches a single OrganizationTenancy by its parent organization OCID and the tenancy's own OCID.

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

Fetches a single OrganizationTenancy by its parent organization OCID and
the tenancy's own OCID.

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

list-organization-tenanciesclj

(list-organization-tenancies organization-id)
(list-organization-tenancies organization-id opts)

Lists tenancies within organization-id, paginating automatically.

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

Options: :region — region-id or 3-letter code :limit — page size (default 100; max 1000)

Lists tenancies within `organization-id`, paginating automatically.

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

Options:
  :region — region-id or 3-letter code
  :limit  — page size (default 100; max 1000)
raw docstring

restore-organization-tenancyclj

(restore-organization-tenancy organization-tenancy-id)
(restore-organization-tenancy organization-tenancy-id opts)

Restores a previously-deleted organization tenancy (async).

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

Restores a previously-deleted organization tenancy (async).

Returns `{:data {:opcWorkRequestId "..."}}` or `{:error ...}`.
raw docstring

unapprove-organization-tenancy-for-transferclj

(unapprove-organization-tenancy-for-transfer compartment-id
                                             organization-tenancy-id)
(unapprove-organization-tenancy-for-transfer compartment-id
                                             organization-tenancy-id
                                             opts)

Cancels a previously-approved transfer of an organization's child tenancy (sync). Returns the updated OrganizationTenancy resource.

compartment-id is required by the SDK.

Options match approve-organization-tenancy-for-transfer.

Cancels a previously-approved transfer of an organization's child tenancy
(sync). Returns the updated OrganizationTenancy resource.

`compartment-id` is required by the SDK.

Options match `approve-organization-tenancy-for-transfer`.
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