Skip to main content

domains

Creates, updates, deletes, gets or lists a domains resource.

Overview​

Namedomains
TypeResource
Idoci.identity.domains

Fields​

The following fields are returned by SELECT queries:

The identity domain was retrieved.

NameDatatypeDescription
idstringThe OCID of the identity domain.
compartmentIdstringThe OCID of the compartment containing the identity domain.
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
descriptionstringThe identity domain description. You can have an empty description.
displayNamestringThe mutable display name of the identity domain.
freeformTagsobjectFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
homeRegionstringThe home region for the identity domain. See [Regions and Availability Domains](/Content/General/Concepts/regions.htm) for the full list of supported region names. Example: us-phoenix-1
homeRegionUrlstringRegion-specific identity domain URL.
isHiddenOnLoginbooleanIndicates whether the identity domain is hidden on the sign-in screen or not.
licenseTypestringThe license type of the identity domain.
lifecycleDetailsstringAny additional details about the current state of the identity domain. (DEACTIVATING, ACTIVATING, UPDATING)
lifecycleStatestringThe current state. (CREATING, ACTIVE, DELETING, INACTIVE)
replicaRegionsarrayThe regions where replicas of the identity domain exist.
timeCreatedstring (date-time)Date and time the identity domain was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
typestringThe type of the domain. (DEFAULT, SECONDARY)
urlstringRegion-agnostic identity domain URL.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectdomainId, regionopc-request-id(For tenancies that support identity domains) Gets the specified identity domain's information.<br />
listselectcompartmentId, regiondisplayName, url, homeRegionUrl, type, licenseType, isHiddenOnLogin, page, limit, name, sortBy, sortOrder, opc-request-id, lifecycleState(For tenancies that support identity domains) Lists all identity domains within a tenancy.<br />
createinsertregion, compartmentId, displayName, description, homeRegion, licenseTypeopc-retry-token, opc-request-id(For tenancies that support identity domains) Creates a new identity domain in the tenancy with the identity domain home in homeRegion.<br />After you send your request, the temporary lifecycleState of this identity domain is set to CREATING and lifecycleDetails to UPDATING.<br />When creation of the identity domain completes, this identity domain's lifecycleState is set to ACTIVE and lifecycleDetails to null.<br /><br />To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves<br />the operation's status.<br /><br />After creating an identity domain, first make sure its lifecycleState changes from CREATING to ACTIVE before you use it.<br />
updateupdatedomainId, regionif-match, opc-request-id(For tenancies that support identity domains) Updates identity domain information and the associated Identity Cloud Service (IDCS) stripe.<br /><br />To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves<br />the operation's status.<br />
deletedeletedomainId, regionif-match, opc-request-id(For tenancies that support identity domains) Deletes an identity domain. The identity domain must have no active apps present in<br />the underlying IDCS stripe. You must also deactivate the identity domain, rendering the lifecycleState of the identity domain INACTIVE.<br />Furthermore, as the authenticated user performing the operation, you cannot be a member of the identity domain you are deleting.<br />Lastly, you cannot delete the default identity domain. A tenancy must always have at least the default identity domain.<br /><br />To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves<br />the operation's status.<br />
activate_domainexecdomainId, regionopc-request-id, opc-retry-token, if-match(For tenancies that support identity domains) Activates a deactivated identity domain. You can only activate identity domains that your user account is not a part of.<br /><br />After you send the request, the lifecycleDetails of the identity domain is set to ACTIVATING. When the operation completes, the<br />lifecycleDetails is set to null and the lifecycleState of the identity domain is set to ACTIVE.<br /><br />To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves<br />the operation's status.<br />
change_compartmentexecdomainId, region, compartmentIdopc-request-id, opc-retry-token, if-match(For tenancies that support identity domains) Moves the identity domain to a different compartment in the tenancy.<br /><br />To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves<br />the operation's status.<br />
change_domain_license_typeexecdomainId, regionopc-request-id, opc-retry-token, if-match(For tenancies that support identity domains) Changes the license type of the given identity domain. The identity domain's<br />lifecycleState must be set to ACTIVE and the requested licenseType must be allowed. To retrieve the allowed licenseType for<br />the identity domain, use [ListAllowedDomainLicenseTypes](#/en/identity/20160918/Domain/ListAllowedDomainLicenseTypes).<br /><br />After you send your request, the lifecycleDetails of this identity domain is set to UPDATING. When the update of the identity<br />domain completes, then the lifecycleDetails is set to null.<br /><br />To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves<br />the operation's status.<br />
deactivate_domainexecdomainId, regionisForceDeactivate, opc-request-id, opc-retry-token, if-match(For tenancies that support identity domains) Deactivates the specified identity domain. Identity domains must be in an ACTIVE<br />lifecycleState and have no active apps present in the domain or underlying Identity Cloud Service stripe. You cannot deactivate<br />the default identity domain.<br /><br />After you send your request, the lifecycleDetails of this identity domain is set to DEACTIVATING. When the operation completes,<br />then the lifecycleDetails is set to null and the lifecycleState is set to INACTIVE.<br /><br />To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves<br />the operation's status.<br />
enable_replication_to_regionexecdomainId, regionopc-request-id, opc-retry-token, if-match(For tenancies that support identity domains) Replicates the identity domain to a new region (provided that the region is the<br />tenancy home region or other region that the tenancy subscribes to). You can only replicate identity domains that are in an ACTIVE<br />lifecycleState and not currently updating or already replicating. You also can only trigger the replication of secondary identity domains.<br />The default identity domain is automatically replicated to all regions that the tenancy subscribes to.<br /><br />After you send the request, the state of the identity domain in the replica region is set to ENABLING_REPLICATION. When the operation<br />completes, the state is set to REPLICATION_ENABLED.<br /><br />To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves<br />the operation's status.<br />

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
compartmentIdstringThe OCID of the compartment (remember that the tenancy is simply the root compartment).
domainIdstringThe OCID of the identity domain.
regionstringOCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
displayNamestringThe mutable display name of the identity domain.
homeRegionUrlstringThe region-specific identity domain URL.
if-matchstringFor optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
isForceDeactivatebooleanIndicates whether domain can be forcefully deactivated even when there are Active Apps present
isHiddenOnLoginbooleanIndicates whether or not the identity domain is visible at the sign-in screen.
licenseTypestringThe license type of the identity domain.
lifecycleStatestringA filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
limitintegerThe maximum number of items to return in a paginated "List" call.
namestringA filter to only return resources that match the given name exactly.
opc-request-idstringUnique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
pagestringThe value of the opc-next-page response header from the previous "List" call.
sortBystringThe field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive. Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these "List" operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.
typestringThe identity domain type.
urlstringThe region-agnostic identity domain URL.

SELECT examples​

(For tenancies that support identity domains) Gets the specified identity domain's information.<br />

SELECT
id,
compartmentId,
definedTags,
description,
displayName,
freeformTags,
homeRegion,
homeRegionUrl,
isHiddenOnLogin,
licenseType,
lifecycleDetails,
lifecycleState,
replicaRegions,
timeCreated,
type,
url
FROM oci.identity.domains
WHERE domainId = '{{ domainId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

(For tenancies that support identity domains) Creates a new identity domain in the tenancy with the identity domain home in homeRegion.<br />After you send your request, the temporary lifecycleState of this identity domain is set to CREATING and lifecycleDetails to UPDATING.<br />When creation of the identity domain completes, this identity domain's lifecycleState is set to ACTIVE and lifecycleDetails to null.<br /><br />To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves<br />the operation's status.<br /><br />After creating an identity domain, first make sure its lifecycleState changes from CREATING to ACTIVE before you use it.<br />

INSERT INTO oci.identity.domains (
adminEmail,
adminFirstName,
adminLastName,
adminUserName,
compartmentId,
definedTags,
description,
displayName,
freeformTags,
homeRegion,
isHiddenOnLogin,
isNotificationBypassed,
isPrimaryEmailRequired,
licenseType,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ adminEmail }}',
'{{ adminFirstName }}',
'{{ adminLastName }}',
'{{ adminUserName }}',
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ description }}' /* required */,
'{{ displayName }}' /* required */,
'{{ freeformTags }}',
'{{ homeRegion }}' /* required */,
{{ isHiddenOnLogin }},
{{ isNotificationBypassed }},
{{ isPrimaryEmailRequired }},
'{{ licenseType }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
;

UPDATE examples​

(For tenancies that support identity domains) Updates identity domain information and the associated Identity Cloud Service (IDCS) stripe.<br /><br />To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves<br />the operation's status.<br />

UPDATE oci.identity.domains
SET 
definedTags = '{{ definedTags }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
isHiddenOnLogin = {{ isHiddenOnLogin }}
WHERE 
domainId = '{{ domainId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}';

DELETE examples​

(For tenancies that support identity domains) Deletes an identity domain. The identity domain must have no active apps present in<br />the underlying IDCS stripe. You must also deactivate the identity domain, rendering the lifecycleState of the identity domain INACTIVE.<br />Furthermore, as the authenticated user performing the operation, you cannot be a member of the identity domain you are deleting.<br />Lastly, you cannot delete the default identity domain. A tenancy must always have at least the default identity domain.<br /><br />To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves<br />the operation's status.<br />

DELETE FROM oci.identity.domains
WHERE domainId = '{{ domainId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
;

Lifecycle Methods​

(For tenancies that support identity domains) Activates a deactivated identity domain. You can only activate identity domains that your user account is not a part of.<br /><br />After you send the request, the lifecycleDetails of the identity domain is set to ACTIVATING. When the operation completes, the<br />lifecycleDetails is set to null and the lifecycleState of the identity domain is set to ACTIVE.<br /><br />To track the progress of the request, submitting an HTTP GET on the /iamWorkRequests/{iamWorkRequestsId} endpoint retrieves<br />the operation's status.<br />

EXEC oci.identity.domains.activate_domain 
@domainId='{{ domainId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}', 
@if-match='{{ if-match }}'
;