PingOne Platform APIs

Trusted Email Addresses

PingOne supports the ability to configure up to 10 trusted email address for an existing trusted email domain. Refer to Trusted email domains.

Trusted email addresses properties

Property Type Required Mutable Description

id

String

Required

Immutable

The auto generated ID of the trusted email address.

environment.id

String

Required

Immutable

The environment resource’s unique identifier associated with the resource.

emailDomain.id

String

Required

Immutable

The trusted email domain resource’s unique identifier associated with the resource.

emailAddress

String

Required

Mutable

The trusted email address, for example john.smith@shopco.com.

status

String

Required

Mutable

The status of the trusted email address. Possible values:

* ACTIVE

* VERIFICATION_REQUIRED

Trusted email address activation request properties

Property Type Required Mutable Description

verificationCode

String

Required

Immutable

A string that specifies a one-time passcode sent to the trusted email address.

Trusted email addresses events generated

Refer to Audit Reporting Events for the events generated.

Trusted email addresses 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.

Trusted email address errors

In addition to the general error codes, trusted email address operations can return the following errors:

HTTP status Top‑level code Detail code When it happens and what the response contains

400

INVALID_DATA

EMPTY_VALUE or INVALID_VALUE

Message: Validation Error : [<field> <message>] (for example, Validation Error : [emailAddress must not be blank] or Validation Error : [emailAddress must be a well-formed email address])

When and details

When: A POST Create Trusted Email Address request omits emailAddress or specifies a value that is not a valid email address, or an Activate Trusted Email Address request omits verificationCode.

Details: Detail EMPTY_VALUE for NotBlank or NotEmpty constraints, INVALID_VALUE for the Email constraint, target = the field path, message = the constraint message.

400

INVALID_REQUEST

INVALID_VALUE or None

Message: The request could not be completed. The request was malformed or invalid.

When and details

When: A request body is malformed JSON or contains a value of the wrong type (for example, a non-UUID trustedEmailID).

Details: For a JSON field conversion error, detail INVALID_VALUE with target = the JSON path of the failing property and message Invalid value for attribute. Otherwise no detail is returned.

400

INVALID_DATA

INVALID_VALUE

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: A POST Create Trusted Email Address request specifies an emailAddress whose domain does not match the trusted email domain, or contains no domain (no @).

Details: Detail INVALID_VALUE with target trustedEmail and the reason: Trusted email domain not found in the environment: <trustedEmail> or the domain of the given email address must be same as owned email domain

400

REQUEST_FAILED

INVALID_VALUE

Message: The request violates a constraint imposed by the service.

When and details

When: A POST Create Trusted Email Address request specifies an emailAddress whose domain’s DNS ownership records are not yet verified.

Details: Detail INVALID_VALUE with target trustedEmail and message the domain of the given email address is not verified.

400

REQUEST_LIMITED

LIMIT_EXCEEDED

Message: The request exceeded the allowed rate limit.

When and details

When: A POST Create Trusted Email Address request exceeds the maximum of 10 trusted email addresses per domain.

Details: Detail LIMIT_EXCEEDED with target trustedEmail and message the given domain reached to max trustedEmails allowed, can not create new trustedEmail.

400

INVALID_DATA

INVALID_VALUE

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: An Activate Trusted Email Address or Resend Verification Code request targets a trusted email address whose status is already ACTIVE.

Details: Detail INVALID_VALUE with target status and message Trusted Email is already ACTIVE.

400

INVALID_DATA

INVALID_VERIFICATION_CODE

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: An Activate Trusted Email Address request submits a verification code that does not match the code sent to the address.

Details: Detail INVALID_VERIFICATION_CODE with target verificationCode and message Invalid Verification Code was provided.

400

REQUEST_LIMITED

QUOTA_EXCEEDED

Message: The request will exceed your quota.

When and details

When: An Activate Trusted Email Address request exceeds the maximum number of unsuccessful verification code attempts for the current session (3).

Details: Detail QUOTA_EXCEEDED with target verificationCode, message Too many unsuccessful Verification Code attempts., and quotaLimit of 3 in innerError.

400

INVALID_DATA

INVALID_VALUE

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: An Activate Trusted Email Address request submits a verification code after the code’s session expired.

Details: Detail INVALID_VALUE with target verificationCode and message The provided passcode was expired.

400

REQUEST_FAILED

CONSTRAINT_VIOLATION

Message: The request violates a constraint imposed by the service.

When and details

When: A DELETE Delete Trusted Email Address request targets an address that is in use as the notifications settings from or replyTo address, or by an email content’s from or replyTo address.

Details: A detail whose target is trustedEmail, whose code field carries The request violates a constraint imposed by the service., and whose message is The given trusted email is already in use in notification settings or The given trusted email is already in use in templates.

403

ACCESS_FAILED

None

Message: The actor attempting to perform the request is not authorized.

When and details

When: The actor lacks the permission for the operation: notifications:create:emailDomain (POST Create Trusted Email Address), notifications:update:emailDomain (Activate Trusted Email Address, Resend Verification Code), notifications:read:emailDomain (GET operations), or notifications:delete:emailDomain (DELETE Delete Trusted Email Address).

Details: None.

404

NOT_FOUND

None

Message: The request could not be completed. The requested resource was not found.

When and details

When: A request specifies an environment or emailDomainID that does not exist.

Details: For an unknown domain, detail without a code, carrying the message Email Domain not found, Id: <emailDomainID>.

404

NOT_FOUND

None

Message: The request could not be completed. The requested resource was not found.

When and details

When: A request specifies a trustedEmailID that does not exist in the domain.

Details: Detail without a code, carrying the message Trusted Email not found, Id: <trustedEmailID>.

500

REQUEST_FAILED

CONSTRAINT_VIOLATION

Message: The request violates a constraint imposed by the service.

When and details

When: The service encounters a database error while processing the request.

Details: Detail without a code, carrying the underlying database error message.