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 |
|---|---|---|---|---|
|
String |
Required |
Immutable |
The auto generated ID of the trusted email address. |
|
String |
Required |
Immutable |
The environment resource’s unique identifier associated with the resource. |
|
String |
Required |
Immutable |
The trusted email domain resource’s unique identifier associated with the resource. |
|
String |
Required |
Mutable |
The trusted email address, for example |
|
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 |
|---|---|---|---|---|
|
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 |
|
|
Message: When and detailsWhen: A Details: Detail |
400 |
|
|
Message: When and detailsWhen: A request body is malformed JSON or contains a value of the wrong type (for example, a non-UUID Details: For a JSON field conversion error, detail |
400 |
|
|
Message: When and detailsWhen: A Details: Detail |
400 |
|
|
Message: When and detailsWhen: A Details: Detail |
400 |
|
|
Message: When and detailsWhen: A Details: Detail |
400 |
|
|
Message: When and detailsWhen: An Activate Trusted Email Address or Resend Verification Code request targets a trusted email address whose status is already Details: Detail |
400 |
|
|
Message: When and detailsWhen: An Activate Trusted Email Address request submits a verification code that does not match the code sent to the address. Details: Detail |
400 |
|
|
Message: When and detailsWhen: An Activate Trusted Email Address request exceeds the maximum number of unsuccessful verification code attempts for the current session (3). Details: Detail |
400 |
|
|
Message: When and detailsWhen: An Activate Trusted Email Address request submits a verification code after the code’s session expired. Details: Detail |
400 |
|
|
Message: When and detailsWhen: A Details: A detail whose target is |
403 |
|
None |
Message: When and detailsWhen: The actor lacks the permission for the operation: Details: None. |
404 |
|
None |
Message: When and detailsWhen: A request specifies an environment or Details: For an unknown domain, detail without a code, carrying the message |
404 |
|
None |
Message: When and detailsWhen: A request specifies a Details: Detail without a code, carrying the message |
500 |
|
|
Message: When and detailsWhen: The service encounters a database error while processing the request. Details: Detail without a code, carrying the underlying database error message. |