Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateDomainDetails

(For tenancies that support identity domains) Details for creating an identity domain.

Properties

Optional adminEmail

adminEmail: undefined | string

The administrator's email address.

Optional adminFirstName

adminFirstName: undefined | string

The administrator's first name.

Optional adminLastName

adminLastName: undefined | string

The administrator's last name.

Optional adminUserName

adminUserName: undefined | string

The administrator's user name.

compartmentId

compartmentId: string

The OCID of the compartment where the identity domain is created.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

description

description: string

The identity domain description. You can have an empty description.

displayName

displayName: string

The mutable display name of the identity domain.

Optional freeformTags

freeformTags: undefined | object

Free-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. Example: {@code {"Department": "Finance"}}

homeRegion

homeRegion: string

The region's name identifier. See Regions and Availability Domains for the full list of supported region names.

Example: {@code us-phoenix-1}

Optional isHiddenOnLogin

isHiddenOnLogin: undefined | false | true

Indicates whether the identity domain is hidden on the sign-in screen or not.

Optional isNotificationBypassed

isNotificationBypassed: undefined | false | true

Indicates whether or not the administrator user created in the IDCS stripe would like to receive notifications like a welcome email. This field is required only if admin information is provided. This field is otherwise optional.

Optional isPrimaryEmailRequired

isPrimaryEmailRequired: undefined | false | true

Optional field to indicate whether users in the identity domain are required to have a primary email address or not. The default is true.

licenseType

licenseType: string

The license type of the identity domain.

Functions

getDeserializedJsonObj

getJsonObj