OCI Organizations API — Domain resource (Tenant Manager Control Plane).
A Domain represents a domain name registration claimed by a tenancy and
verified via a DNS TXT record. Five ops served by DomainClient:
create-domain — begin domain registration (201 + Domain body + workReqId)get-domain — fetch a Domainlist-domains — list Domains in a compartment (paginated, filterable)update-domain — update tags only (sync; SDK does not surface other mutables)delete-domain — release the domain (async; the SDK omits the
opc-work-request-id header on this op, so the wrapper
returns {:data {}} on acceptance)list-domains filters by domainId, lifecycleState, status, name,
plus standard sortBy/sortOrder/limit/page. Note the lifecycleState
filter uses the shared LifecycleState enum (6 values) even though the
Domain model only ever populates 3 (Active/Deleted/Failed).
Region routing follows the standard pattern.
OCI Organizations API — Domain resource (Tenant Manager Control Plane).
A Domain represents a domain name registration claimed by a tenancy and
verified via a DNS TXT record. Five ops served by `DomainClient`:
- `create-domain` — begin domain registration (201 + Domain body + workReqId)
- `get-domain` — fetch a Domain
- `list-domains` — list Domains in a compartment (paginated, filterable)
- `update-domain` — update tags only (sync; SDK does not surface other mutables)
- `delete-domain` — release the domain (async; the SDK omits the
`opc-work-request-id` header on this op, so the wrapper
returns `{:data {}}` on acceptance)
`list-domains` filters by `domainId`, `lifecycleState`, `status`, `name`,
plus standard `sortBy`/`sortOrder`/`limit`/`page`. Note the `lifecycleState`
filter uses the *shared* `LifecycleState` enum (6 values) even though the
`Domain` model only ever populates 3 (`Active`/`Deleted`/`Failed`).
Region routing follows the standard pattern.(create-domain details)(create-domain details opts)Begins the registration process for claiming a domain.
The response is hybrid: the SDK returns 201 with both the new Domain
resource and an opc-work-request-id (the work request continues the
verification asynchronously). Both surface in :data: the Domain fields
directly, and :opcWorkRequestId for the verification work request.
Returns {:data {... :opcWorkRequestId "..."}} or {:error ...}.
details map:
:compartment-id (required, tenancy OCID)
:domain-name (required)
:subscription-email (optional)
:is-governance-enabled (optional, boolean)
:freeform-tags (optional, {string string})
:defined-tags (optional, {string {string Object}})
Options: :region — region-id or 3-letter code :opc-retry-token — idempotency token (expires after 24h)
Begins the registration process for claiming a domain.
The response is hybrid: the SDK returns 201 with both the new Domain
resource and an `opc-work-request-id` (the work request continues the
verification asynchronously). Both surface in `:data`: the Domain fields
directly, and `:opcWorkRequestId` for the verification work request.
Returns `{:data {... :opcWorkRequestId "..."}}` or `{:error ...}`.
`details` map:
:compartment-id (required, tenancy OCID)
:domain-name (required)
:subscription-email (optional)
:is-governance-enabled (optional, boolean)
:freeform-tags (optional, {string string})
:defined-tags (optional, {string {string Object}})
Options:
:region — region-id or 3-letter code
:opc-retry-token — idempotency token (expires after 24h)(delete-domain domain-id)(delete-domain domain-id opts)Releases the domain so another tenancy can claim it (async).
Unlike the other async ops in this namespace tree, the SDK does not
surface an opc-work-request-id for DeleteDomain (the response object
has no getOpcWorkRequestId getter), so the wrapper returns
{:data {}} on a 202 acceptance and {:error ...} on failure.
Releases the domain so another tenancy can claim it (async).
Unlike the other async ops in this namespace tree, the SDK does *not*
surface an `opc-work-request-id` for `DeleteDomain` (the response object
has no `getOpcWorkRequestId` getter), so the wrapper returns
`{:data {}}` on a 202 acceptance and `{:error ...}` on failure.(get-domain domain-id)(get-domain domain-id opts)Fetches a single Domain by OCID.
Returns {:data {...}} or {:error ...}.
Fetches a single Domain by OCID.
Returns `{:data {...}}` or `{:error ...}`.(list-domains compartment-id)(list-domains compartment-id opts)Lists Domains in compartment-id, paginating automatically.
Returns {:data {:items [domain-maps...]}} or {:error ...}.
Options:
:region — region-id or 3-letter code
:domain-id — exact-match filter on Domain OCID
:lifecycle-state — keyword from the shared LifecycleState enum:
:creating/:active/:inactive/:updating/
:failed/:terminated
:status — keyword from Domain$Status:
:pending/:releasing/:released/:expiring/
:revoking/:revoked/:active/:failed
:name — exact-match filter
:sort-by — :time-created or :display-name
:sort-order — :asc or :desc
:limit — page size (default 100; max 1000)
Lists Domains in `compartment-id`, paginating automatically.
Returns `{:data {:items [domain-maps...]}}` or `{:error ...}`.
Options:
:region — region-id or 3-letter code
:domain-id — exact-match filter on Domain OCID
:lifecycle-state — keyword from the shared LifecycleState enum:
`:creating`/`:active`/`:inactive`/`:updating`/
`:failed`/`:terminated`
:status — keyword from Domain$Status:
`:pending`/`:releasing`/`:released`/`:expiring`/
`:revoking`/`:revoked`/`:active`/`:failed`
:name — exact-match filter
:sort-by — `:time-created` or `:display-name`
:sort-order — `:asc` or `:desc`
:limit — page size (default 100; max 1000)(update-domain domain-id details)(update-domain domain-id details opts)Updates the Domain's tags (sync). The OCI SDK exposes only freeformTags
and definedTags as mutables on this op.
Returns {:data {...}} (the updated Domain) or {:error ...}.
details map:
:freeform-tags — optional {string string}
:defined-tags — optional {string {string Object}}
Options: :region — region-id or 3-letter code :if-match — etag for optimistic concurrency
Updates the Domain's tags (sync). The OCI SDK exposes only `freeformTags`
and `definedTags` as mutables on this op.
Returns `{:data {...}}` (the updated Domain) or `{:error ...}`.
`details` map:
:freeform-tags — optional `{string string}`
:defined-tags — optional `{string {string Object}}`
Options:
:region — region-id or 3-letter code
:if-match — etag for optimistic concurrencycljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |