PingOne supports the ability to configure one trusted email domain for each environment. A trusted email domain with its associated email addresses enable PingOne to send emails on your organization’s behalf. To implement a trusted email domain, you’ll need to add DNS records and setup DKIM and SPF.

To create and manage trusted email addresses associated with your trusted email domain, see Trusted email addresses.

Trusted email domain properties

Property Description
id A string that specifies the auto-generated ID of the email domain.
domainName A string that specifies the resource name, which must be provided and must be unique within an environment (for example, auth.shopco.com). This is a required property. Wildcards are NOT supported.
environment.id A string that specifies the environment resource’s unique identifier associated with the resource.

Trusted email domain ownership properties

Property Description
type A string that specifies the type of DNS record, with the value “TXT”.
regions The regions collection specifies the properties for the 3 AWS SES regions that are used for sending email for the environment. The regions are determined by the geography where this environment was provisioned (North America, Europe & Asia-Pacific). Each item in the regions collection is an object with these properties:
  • name:
    The name of the region.
  • status:
    The status of the email domain ownership. Possible values:
    • ACTIVE
    • VERIFICATION_REQUIRED
  • key:
    Record name.
  • value:
    Record value.

Trusted email domain DKIM properties

Property Description
type A string that specifies the type of DNS record, with the value “CNAME”.
regions The regions collection specifies the properties for the 3 AWS SES regions that are used for sending email for the environment. The regions are determined by the geography where this environment was provisioned (North America, Europe & Asia-Pacific). Each item in the regions collection is an object with these properties:
  • name:
    The name of the region.
  • status:
    The status of the email domain ownership. Possible values:
    • ACTIVE
    • VERIFICATION_REQUIRED
  • tokens:
    A collection of key and value pairs. Each item in the tokens collection is an object with these properties:
    • key:
      Record name.
    • value:
      Record value.

Trusted email domain SPF properties

Property Description
type A string that specifies the type of DNS record, with the value “TXT”.
status The status of the email domain ownership. Possible values:
  • ACTIVE
  • VERIFICATION_REQUIRED
key Record name.
value Record value.

Trusted email domains response codes

Code Message
200 Successful operation.
201 Successfully created.
204 Successfully removed. No content.
400 The request could not be completed.
401 You do not have access to this resource.
403 You do not have permissions or are not licensed to make this request.
404 The requested resource was not found.