Oracle ${email Domain Tag} API

openapi: 3.2.0
info:
  description: "Use the Email Delivery API to do the necessary set up to send high-volume and application-generated emails through the OCI Email Delivery service.\nFor more information, see [Overview of the Email Delivery Service](/iaas/Content/Email/Concepts/overview.htm).\n\n **Note:** Write actions (POST, UPDATE, DELETE) may take several minutes to propagate and be reflected by the API.\n If a subsequent read request fails to reflect your changes, wait a few minutes and try again.\n"
  license:
    name: Oracle Corporation
  title: Email Delivery ${email Domain Tag} ${email Domain Tag} API
  version: '20170907'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/2b8421e2e819f20bff147090f9d2586190bb5c6d3b8562ffb01d9f9fa99542be.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Email Delivery API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/2b8421e2e819f20bff147090f9d2586190bb5c6d3b8562ffb01d9f9fa99542be.yaml
    what: the harvested document for Email Delivery API
servers:
- url: https://127.0.0.1/20170907
tags:
- name: ${email-domain-tag}
paths:
  /emailDomains:
    get:
      description: Lists email domains in the specified compartment.
      operationId: ListEmailDomains
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/compartmentIdQueryParam'
      - $ref: '#/components/parameters/FilterByIdQueryParam'
      - $ref: '#/components/parameters/FilterByNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - description: 'Filter returned list by specified lifecycle state. This parameter is case-insensitive.

          '
        in: query
        name: lifecycleState
        required: false
        x-obmcs-enumref: '#/definitions/EmailDomain/lifecycleState'
        schema:
          type: string
      - description: 'Specifies the attribute with which to sort the email domains.


          Default: `TIMECREATED`


          * **TIMECREATED:** Sorts by timeCreated.

          * **NAME:** Sorts by name.

          * **ID:** Sorts by id.

          '
        in: query
        name: sortBy
        required: false
        schema:
          type: string
          enum:
          - TIMECREATED
          - ID
          - NAME
          default: TIMECREATED
      responses:
        '200':
          description: Success
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain.

                For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDomainCollection'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Lists email domains.
      tags:
      - ${email-domain-tag}
      x-example: 'Sample: List all email domains in a compartment, sorted by newest first


        GET /20170907/emailDomains?compartmentId=ocid1.compartment.oc1... HTTP/1.1

        Host: ctrl.email.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/EmailDomain'
    post:
      description: Creates a new email domain. Avoid entering confidential information.
      operationId: CreateEmailDomain
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '201':
          description: Success
          headers:
            Content-Location:
              description: 'The full URI of the resource related to the request

                '
              schema:
                type: string
                format: uri-reference
            Location:
              description: 'The full URI of the resource related to the request

                '
              schema:
                type: string
                format: uri-reference
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDomain'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Creates a new email domain.
      tags:
      - ${email-domain-tag}
      x-example: 'POST /20170907/emailDomains HTTP/1.1

        Host: ctrl.email.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/EmailDomain'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEmailDomainDetails'
        description: The email domain to create.
        required: true
  /emailDomains/{emailDomainId}:
    delete:
      description: Deletes an email domain.
      operationId: DeleteEmailDomain
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/EmailDomainIdPathParam'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        '202':
          description: 'The request to delete the email domain was accepted for processing.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '412':
          $ref: '#/components/responses/412'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Deletes an email domain.
      tags:
      - ${email-domain-tag}
      x-example: 'DELETE /20170907/emailDomains/ocid1.emailemaildomain.oc1... HTTP/1.1

        Host: ctrl.email.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/EmailDomain'
    get:
      description: Retrieves the specified email domain.
      operationId: GetEmailDomain
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/EmailDomainIdPathParam'
      responses:
        '200':
          description: Success
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDomain'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Retrieves the specified email domain.
      tags:
      - ${email-domain-tag}
      x-example: 'GET /20170907/emailDomains/ocid1.emailemaildomain.oc1... HTTP/1.1

        Host: ctrl.email.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/EmailDomain'
    put:
      description: Modifies an email domain.
      operationId: UpdateEmailDomain
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/EmailDomainIdPathParam'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        '202':
          description: 'The request to update the email domain was accepted for processing.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Modifies an email domain.
      tags:
      - ${email-domain-tag}
      x-example: 'PUT /20170907/emailDomains/ocid1.emailemaildomain.oc1... HTTP/1.1

        Host: ctrl.email.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/EmailDomain'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEmailDomainDetails'
        description: The new email domain attributes to apply.
        required: true
  /emailDomains/{emailDomainId}/actions/addLock:
    post:
      description: Adds a lock to a resource.
      operationId: AddEmailDomainLock
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/EmailDomainIdPathParam'
      responses:
        '200':
          description: Lock is added.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDomain'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Adds a lock to a resource.
      tags:
      - ${email-domain-tag}
      x-related-resource: '#/definitions/EmailDomain'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddLockDetails'
        description: Details for adding a lock to a resource.
        required: true
  /emailDomains/{emailDomainId}/actions/changeCompartment:
    post:
      description: 'Moves an email domain into a different compartment.

        When provided, If-Match is checked against ETag value of the resource.

        For information about moving resources between compartments, see

        [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).


        **Note:** All DKIM objects associated with this email domain will also be moved into the provided compartment.

        '
      operationId: ChangeEmailDomainCompartment
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/EmailDomainIdPathParam'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: 'The request to move the email domain to a different compartment was accepted for processing.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Moves an email domain into a different compartment.
      tags:
      - ${email-domain-tag}
      x-example: "POST /20170907/emailDomains/ocid1.emailemaildomain.oc1.../actions/changeCompartment HTTP/1.1\nHost: ctrl.email.us-phoenix-1.oci.oraclecloud.com\n <var>&lt;authorization and other headers&gt;</var>\n"
      x-related-resource: '#/definitions/EmailDomain'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeEmailDomainCompartmentDetails'
        description: The configuration details for the move operation.
        required: true
  /emailDomains/{emailDomainId}/actions/removeLock:
    post:
      description: Remove a lock to a resource.
      operationId: RemoveEmailDomainLock
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/EmailDomainIdPathParam'
      responses:
        '200':
          description: Lock is Removed.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailDomain'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Remove a lock to a resource.
      tags:
      - ${email-domain-tag}
      x-related-resource: '#/definitions/EmailDomain'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveLockDetails'
        description: Details for removing a lock from a resource.
        required: true
components:
  schemas:
    ResourceLock:
      description: 'Resource locks prevent certain APIs from being called for the resource.

        A full lock prevents both updating and deleting the resource. A delete lock

        prevents deleting the resource.

        '
      properties:
        compartmentId:
          description: The lock compartment ID.
          type: string
        message:
          description: 'A message added by the lock creator. The message typically gives an

            indication of why the resource is locked.

            '
          type: string
        relatedResourceId:
          description: 'The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.

            '
          type: string
        timeCreated:
          description: Indicates when the lock was created, in the format defined by RFC 3339.
          format: date-time
          type: string
        type:
          description: Lock type.
          enum:
          - FULL
          - DELETE
          type: string
      required:
      - type
      - compartmentId
      type: object
    EmailDomainCollection:
      description: Results of an EmailDomain search. Contains both EmailDomainSummary items and other information, such as metadata.
      properties:
        items:
          description: List of email domains.
          items:
            $ref: '#/components/schemas/EmailDomainSummary'
          type: array
      required:
      - items
      type: object
    Error:
      description: An error has occurred.
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing. See

            [API Errors](/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    CreateEmailDomainDetails:
      description: 'The configuration details for creating a new email domain.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment for this email domain.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported as valid value type.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined 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"}}`

            '
          type: object
        description:
          description: 'A string that describes the details about the domain. It does not have to be unique,

            and you can change it. Avoid entering confidential information.

            '
          maxLength: 400
          minLength: 1
          type: string
        domainVerificationId:
          default: null
          description: Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: '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](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        name:
          description: 'The name of the email domain in the Internet Domain Name System (DNS).

            The email domain name must be unique in the region for this tenancy.

            Domain names limited to ASCII characters use alphanumeric, dash ("-"), and dot (".") characters.

            The dash and dot are only allowed between alphanumeric characters.

            For details, see [RFC 5321, section 4.1.2](https://tools.ietf.org/html/rfc5321#section-4.1.2)

            Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).

            '
          maxLength: 253
          minLength: 3
          type: string
      required:
      - name
      - compartmentId
      type: object
      x-example: "{\n  \"name\": \"mydomain.example.com\",\n  \"compartmentId\": \"ocid1.compartment.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n}\n"
    ChangeEmailDomainCompartmentDetails:
      description: The configuration details for the move operation.
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the specified

            resource to.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
      x-example: "{\n  \"compartmentId\": \"ocid1.compartment.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n}\n"
    AddLockDetails:
      description: 'Request payload to add lock to the resource.

        '
      properties:
        compartmentId:
          description: The lock compartment ID.
          type: string
        message:
          description: 'A message added by the lock creator. The message typically gives an

            indication of why the resource is locked.

            '
          type: string
        relatedResourceId:
          description: 'The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.

            '
          type: string
        type:
          description: Lock type.
          enum:
          - FULL
          - DELETE
          type: string
      required:
      - type
      type: object
    EmailDomain:
      description: 'The properties that define an email domain.

        An email domain contains configuration used to assert responsibility for emails sent from that domain.

        '
      properties:
        activeDkimId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DKIM key

            that will be used to sign mail sent from this email domain.

            '
          maxLength: 255
          minLength: 1
          type: string
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains this email domain.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported as valid value type.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined 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"}}`

            '
          type: object
        description:
          description: The description of an email domain.
          maxLength: 400
          type: string
        domainVerificationId:
          description: Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
          type: string
        domainVerificationStatus:
          description: The current domain verification status.
          enum:
          - NONE
          - DOMAINID
          - OTHER
          type: string
          x-obmcs-top-level-enum: '#/definitions/DomainVerificationStatusType'
        freeformTags:
          additionalProperties:
            type: string
          description: '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](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the email domain.

            '
          maxLength: 255
          minLength: 1
          type: string
        isSpf:
          default: false
          description: 'Value of the SPF field. For more information about SPF, please see

            [SPF Authentication](/iaas/Content/Email/Concepts/overview.htm#components).

            '
          type: boolean
        lifecycleState:
          description: The current state of the email domain.
          enum:
          - ACTIVE
          - CREATING
          - DELETING
          - DELETED
          - FAILED
          - UPDATING
          type: string
          x-default-description: 'null'
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/ResourceLock'
          type: array
        name:
          description: 'The name of the email domain in the Internet Domain Name System (DNS).


            Example: `mydomain.example.com`

            '
          maxLength: 253
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'The time the email domain was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339)

            timestamp format, "YYYY-MM-ddThh:mmZ".


            Example: `2021-02-12T22:47:12.613Z`

            '
          format: date-time
          type: string
      required:
      - name
      - id
      type: object
    EmailDomainSummary:
      description: 'The properties that define an email domain.

        An email domain contains configuration used to assert responsibility for emails sent from that domain.

        '
      properties:
        activeDkimId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DKIM key

            that is adding the DKIM signature for this email domain.

            '
          maxLength: 255
          minLength: 1
          type: string
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains this email domain.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported as valid value type.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined 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"}}`

            '
          type: object
        description:
          description: The description of an email domain.
          maxLength: 400
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: '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](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the email domain.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current state of the email domain.
          type: string
          x-obmcs-enumref: '#/definitions/EmailDomain/lifecycleState'
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/ResourceLock'
          type: array
        name:
          description: 'The name of the email domain in the Internet Domain Name System (DNS).


            Example: `mydomain.example.com`

            '
          maxLength: 253
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and bo

# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-email-domain-tag-api-openapi.yml