Email Delivery Settings

authentication

Object

Required

Mutable

Contains the information for authenticating with the email provider.

authentication.authToken

String

Required

Mutable

If you specified BEARER as the authentication method, use authToken to provide the bearer token to use.

authentication.authUrl

String

Required

Mutable

The URL of the authorization server that provides the access token.
Required when authentication.method=OAUTH2

authentication.clientAuthenticationMethod

String

N/A

Read-only

The method used for sending the client ID and secret. Returned in responses for custom providers that require OAuth 2 authentication. Currently, value returned is always BASIC_AUTH_HEADER.

authentication.clientId

String

Required

Mutable

The client’s public identifier.
Required when authentication.method=OAUTH2

authentication.clientSecret

String

Required

Mutable

The client’s secret.
Required when authentication.method=OAUTH2

authentication.grantType

String

N/A

Read-only

The grant type used. Returned in responses for custom providers that require OAuth 2 authentication. Currently, value returned is always CLIENT_CREDENTIALS.

authentication.headerName

String

Required

Mutable

The name of the custom header used for authentication.
Required when authentication.method=CUSTOM_HEADER

authentication.headerValue

String

Required

Mutable

The value to use for the custom header used for authentication.
Required when authentication.method=CUSTOM_HEADER

authentication.method

String

Required

Mutable

The custom provider account’s authentication method. Possible values:

* BASIC - username/password

* BEARER - bearer token

* OAUTH2 - OAuth 2

* CUSTOM_HEADER - authentication using a custom header

authentication.password

String

Required

Mutable

If you specified BASIC as the authentication method, use password to provide the password for authenticating with the email provider.

authentication.username

String

Required

Mutable

If you specified BASIC as the authentication method, use username to provide the username for authenticating with the email provider.

environment.id

String

N/A

Read-only

The environment’s unique identifier.

from

Object

Optional

Mutable

Contains the "from" information to use for the notifications.

from.name

String

Optional

Mutable

The "from" name to use in the notifications that are sent.

from.address

String

Optional

Mutable

The "from" address to use in the notifications that are sent.

name

String

Required

Mutable

Name to use to identify the provider.

protocol

String

Required

Immutable

Set to HTTP when configuring an external email provider.

provider

String

Required

Immutable

Must be set to CUSTOM_PROVIDER.

replyTo

Object

Optional

Mutable

Contains the "reply-to" information to use for the notifications.

replyTo.name

String

Optional

Mutable

The "reply-to" name to use in the notifications that are sent.

replyTo.address

String

Optional

Mutable

The "reply-to" address to use in the notifications that are sent.

requests

Array

Required

Mutable

Contains the object that is used to configure the API requests sent to the email provider.

requests[].body

String

Required

Mutable

Required if method is set to POST. Use body to provide the content of the body for the request sent to the email provider. The body that you define must include the mandatory PingOne variables for notifications: ${from}, ${to}, and ${message}. You can also include any optional notification variables.
If you are including the header content-type: application/json in requests[].headers:

* The content of requests[].body must be valid JSON

* You must enclose the JSON object in quotation marks and escape all quotation marks within the string, for example, "{\"From\": \"${from}\",\"To\": \"${to}\",\"message2\": \"${message}\"}".

requests[].deliveryMethod

String

Required

Immutable

Should be set to EMAIL.

requests[].headers

Object

Required

Mutable

Use this object to specify the headers that your email provider’s API expects.

requests[].method

String

Required

Mutable

Use method to specify the type of API request the email provider requires. Valid values are GET and POST.

requests[].url

String

Required

Mutable

Use url to specify the endpoint for your email provider, for example, https://api.example.com/email. If method is set to GET, append to the URL the various query parameters that the email provider’s API requires. The URL must also include the required PingOne variables, as described for the body parameter.

updatedAt

Date

N/A

Read-only

The date and time the email delivery settings were last updated.