diff --git a/reference.md b/reference.md index c30035a4..ee872ab1 100644 --- a/reference.md +++ b/reference.md @@ -714,14 +714,6 @@ client.branding().update(
create:clients scope).
-Update: Returns 200 when an existing client is updated (requires update:clients scope).
+**Create:** Returns 201 when a new client is created (requires `create:clients` scope).
+**Update:** Returns 200 when an existing client is updated (requires `update:clients` scope).
This endpoint automatically:
-credentials object requires different properties depending on the phone provider (which is specified using the name property).
+Create a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).
+The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
credentials object requires different properties depending on the phone provider (which is specified using the name property).
+Update a [phone provider](https://auth0.com/docs/customize/phone-messages/configure-phone-messaging-providers).
+The `credentials` object requires different properties depending on the phone provider (which is specified using the `name` property).
credentials object
-requires different properties depending on the email provider (which is specified using the name property):
-mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- North America. eu or null are the only valid values for region.
- mailgun requires api_key and domain. Optionally, set region to
- eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- null are the only valid values for region.
- ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- smtp_pass
- settings object with different configuration
+Create an [email provider](https://auth0.com/docs/email/providers). The `credentials` object
+requires different properties depending on the email provider (which is specified using the `name` property):
+
+- `mandrill` requires `api_key`
+- `sendgrid` requires `api_key`
+- `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use
+ the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in
+ North America. `eu` or `null` are the only valid values for `region`.
+- `mailgun` requires `api_key` and `domain`. Optionally, set `region` to
+ `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or
+ `null` are the only valid values for `region`.
+- `ses` requires `accessKeyId`, `secretAccessKey`, and `region`
+- `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and
+ `smtp_pass`
+
+Depending on the type of provider it is possible to specify `settings` object with different configuration
options, which will be used when sending an email:
-smtp provider, settings may contain headers object.
- X-SES-Configuration-Set header. Value must be a string.
- X-MSYS_API header. Value must be an object.
- ses provider, settings may contain message object, where you can provide
- a name of configuration set in configuration_set_name property. Value must be a string.
- credentials object
-requires different properties depending on the email provider (which is specified using the name property):
-mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- North America. eu or null are the only valid values for region.
- mailgun requires api_key and domain. Optionally, set region to
- eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- null are the only valid values for region.
- ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- smtp_pass
- settings object with different configuration
+Update an [email provider](https://auth0.com/docs/email/providers). The `credentials` object
+requires different properties depending on the email provider (which is specified using the `name` property):
+
+- `mandrill` requires `api_key`
+- `sendgrid` requires `api_key`
+- `sparkpost` requires `api_key`. Optionally, set `region` to `eu` to use
+ the SparkPost service hosted in Western Europe; set to `null` to use the SparkPost service hosted in
+ North America. `eu` or `null` are the only valid values for `region`.
+- `mailgun` requires `api_key` and `domain`. Optionally, set `region` to
+ `eu` to use the Mailgun service hosted in Europe; set to `null` otherwise. `eu` or
+ `null` are the only valid values for `region`.
+- `ses` requires `accessKeyId`, `secretAccessKey`, and `region`
+- `smtp` requires `smtp_host`, `smtp_port`, `smtp_user`, and
+ `smtp_pass`
+
+Depending on the type of provider it is possible to specify `settings` object with different configuration
options, which will be used when sending an email:
-smtp provider, settings may contain headers object.
- X-SES-Configuration-Set header. Value must be a string.
- X-MSYS_API header. Value must be an object.
- ses provider, settings may contain message object, where you can provide
- a name of configuration set in configuration_set_name property. Value must be a string.
- Create: Returns 201 when a new client is created (requires create:clients scope).
* Update: Returns 200 when an existing client is updated (requires update:clients scope).
This endpoint automatically:
- *Create: Returns 201 when a new client is created (requires create:clients scope).
* Update: Returns 200 when an existing client is updated (requires update:clients scope).
This endpoint automatically:
- *Create: Returns 201 when a new client is created (requires create:clients scope).
* Update: Returns 200 when an existing client is updated (requires update:clients scope).
This endpoint automatically:
- *create:clients scope).
* Update: Returns 200 when an existing client is updated (requires update:clients scope).
* This endpoint automatically:
- *Create: Returns 201 when a new client is created (requires create:clients scope).
* Update: Returns 200 when an existing client is updated (requires update:clients scope).
This endpoint automatically:
- *Create: Returns 201 when a new client is created (requires create:clients scope).
* Update: Returns 200 when an existing client is updated (requires update:clients scope).
This endpoint automatically:
- *Create: Returns 201 when a new client is created (requires create:clients scope).
* Update: Returns 200 when an existing client is updated (requires update:clients scope).
This endpoint automatically:
- *Create: Returns 201 when a new client is created (requires create:clients scope).
* Update: Returns 200 when an existing client is updated (requires update:clients scope).
This endpoint automatically:
- *credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
* smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
* smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * smtp provider, settings may contain headers object.
X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.For ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.
credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.For ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.
credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.For ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.
credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * smtp provider, settings may contain headers object.
X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.For ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.
credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
* smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
* smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * smtp provider, settings may contain headers object.
X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.For ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.
credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.For ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.
credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.For ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.
credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * smtp provider, settings may contain headers object.
X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.For ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.
credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
* smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
* smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * smtp provider, settings may contain headers object.
X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.For ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.
credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.For ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.
credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.For ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.
credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * smtp provider, settings may contain headers object.
X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.For ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.
credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
* smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
* smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * smtp provider, settings may contain headers object.
X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.For ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.
credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.For ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.
credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.For ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.
credentials object
* requires different properties depending on the email provider (which is specified using the name property):
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
- * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
- * North America. eu or null are the only valid values for region.
- * mailgun requires api_key and domain. Optionally, set region to
- * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
- * null are the only valid values for region.
- * ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
- * smtp_pass
- * mandrill requires api_keysendgrid requires api_keysparkpost requires api_key. Optionally, set region to eu to use
+ * the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in
+ * North America. eu or null are the only valid values for region.mailgun requires api_key and domain. Optionally, set region to
+ * eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or
+ * null are the only valid values for region.ses requires accessKeyId, secretAccessKey, and regionsmtp requires smtp_host, smtp_port, smtp_user, and
+ * smtp_passsettings object with different configuration
- * options, which will be used when sending an email:
+ * Depending on the type of provider it is possible to specify settings object with different configuration
+ * options, which will be used when sending an email:
smtp provider, settings may contain headers object.
- * X-SES-Configuration-Set header. Value must be a string.
- * X-MSYS_API header. Value must be an object.
- * ses provider, settings may contain message object, where you can provide
- * a name of configuration set in configuration_set_name property. Value must be a string.
- * smtp provider, settings may contain headers object.
X-SES-Configuration-Set header. Value must be a string.X-MSYS_API header. Value must be an object.For ses provider, settings may contain message object, where you can provide
+ * a name of configuration set in configuration_set_name property. Value must be a string.
session_lifetime.
+ */
+ @JsonProperty("session_lifetime_in_minutes")
+ public Optionalidle_session_lifetime.
+ */
+ @JsonProperty("idle_session_lifetime_in_minutes")
+ public Optionalephemeral_session_lifetime.
+ */
+ @JsonProperty("ephemeral_session_lifetime_in_minutes")
+ public Optionalidle_ephemeral_session_lifetime.
+ */
+ @JsonProperty("idle_ephemeral_session_lifetime_in_minutes")
+ public OptionalNumber of minutes a session will stay valid. Cannot be specified together with session_lifetime.
Number of hours for which a session can be inactive before the user must log in again.
*/ @@ -1128,6 +1252,20 @@ public Builder idleSessionLifetime(Integer idleSessionLifetime) { return this; } + /** + *Number of minutes a session can be inactive before the user must log in again. Cannot be specified together with idle_session_lifetime.
Number of hours an ephemeral (non-persistent) session will stay valid.
*/ @@ -1156,6 +1294,34 @@ public Builder idleEphemeralSessionLifetime(Integer idleEphemeralSessionLifetime return this; } + /** + *Number of minutes an ephemeral (non-persistent) session will stay valid. Cannot be specified together with ephemeral_session_lifetime.
Number of minutes an ephemeral (non-persistent) session can be inactive before the user must log in again. Cannot be specified together with idle_ephemeral_session_lifetime.
Selected sandbox version for the extensibility environment
*/ @@ -1212,6 +1378,39 @@ public Builder enabledLocales(ListWhether session metadata is included in specific tenant logs (slo, oidc_backchannel_logout_failed, oidc_backchannel_logout_succeeded).
+ */ + @JsonSetter(value = "include_session_metadata_in_tenant_logs", nulls = Nulls.SKIP) + public Builder includeSessionMetadataInTenantLogs(OptionalWhether OTP autocomplete (autocomplete="one-time-code") is enabled.
- */ - @JsonSetter(value = "otp_autocomplete", nulls = Nulls.SKIP) - public Builder otpAutocomplete(OptionalThe client ID this client uses while creating invitations through My Organization API.
+ */ + _FinalStage invitationLandingClientId(OptionalThe client ID this client uses while creating invitations through My Organization API.
+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage invitationLandingClientId(String invitationLandingClientId) { + this.invitationLandingClientId = Optional.ofNullable(invitationLandingClientId); + return this; + } + + /** + *The client ID this client uses while creating invitations through My Organization API.
+ */ + @java.lang.Override + @JsonSetter(value = "invitation_landing_client_id", nulls = Nulls.SKIP) + public _FinalStage invitationLandingClientId(OptionalThe allowed connection strategies for the My Organization Configuration.
* @return Reference to {@code this} so that method calls can be chained together. @@ -269,6 +313,7 @@ public ClientMyOrganizationPatchConfiguration build() { userAttributeProfileId, allowedStrategies, connectionDeletionBehavior, + invitationLandingClientId, additionalProperties); } diff --git a/src/main/java/com/auth0/client/mgmt/types/ClientMyOrganizationPostConfiguration.java b/src/main/java/com/auth0/client/mgmt/types/ClientMyOrganizationPostConfiguration.java index a4080a36..893627af 100644 --- a/src/main/java/com/auth0/client/mgmt/types/ClientMyOrganizationPostConfiguration.java +++ b/src/main/java/com/auth0/client/mgmt/types/ClientMyOrganizationPostConfiguration.java @@ -31,6 +31,8 @@ public final class ClientMyOrganizationPostConfiguration { private final ClientMyOrganizationDeletionBehaviorEnum connectionDeletionBehavior; + private final OptionalThe client ID this client uses while creating invitations through My Organization API.
+ */ + _FinalStage invitationLandingClientId(OptionalThe client ID this client uses while creating invitations through My Organization API.
+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage invitationLandingClientId(String invitationLandingClientId) { + this.invitationLandingClientId = Optional.ofNullable(invitationLandingClientId); + return this; + } + + /** + *The client ID this client uses while creating invitations through My Organization API.
+ */ + @java.lang.Override + @JsonSetter(value = "invitation_landing_client_id", nulls = Nulls.SKIP) + public _FinalStage invitationLandingClientId(OptionalThe allowed connection strategies for the My Organization Configuration.
* @return Reference to {@code this} so that method calls can be chained together. @@ -269,6 +313,7 @@ public ClientMyOrganizationPostConfiguration build() { userAttributeProfileId, allowedStrategies, connectionDeletionBehavior, + invitationLandingClientId, additionalProperties); } diff --git a/src/main/java/com/auth0/client/mgmt/types/ClientMyOrganizationResponseConfiguration.java b/src/main/java/com/auth0/client/mgmt/types/ClientMyOrganizationResponseConfiguration.java index 5897b858..f7db3abe 100644 --- a/src/main/java/com/auth0/client/mgmt/types/ClientMyOrganizationResponseConfiguration.java +++ b/src/main/java/com/auth0/client/mgmt/types/ClientMyOrganizationResponseConfiguration.java @@ -31,6 +31,8 @@ public final class ClientMyOrganizationResponseConfiguration { private final ClientMyOrganizationDeletionBehaviorEnum connectionDeletionBehavior; + private final OptionalThe client ID this client uses while creating invitations through My Organization API.
+ */ + _FinalStage invitationLandingClientId(OptionalThe client ID this client uses while creating invitations through My Organization API.
+ * @return Reference to {@code this} so that method calls can be chained together. + */ + @java.lang.Override + public _FinalStage invitationLandingClientId(String invitationLandingClientId) { + this.invitationLandingClientId = Optional.ofNullable(invitationLandingClientId); + return this; + } + + /** + *The client ID this client uses while creating invitations through My Organization API.
+ */ + @java.lang.Override + @JsonSetter(value = "invitation_landing_client_id", nulls = Nulls.SKIP) + public _FinalStage invitationLandingClientId(OptionalThe allowed connection strategies for the My Organization Configuration.
* @return Reference to {@code this} so that method calls can be chained together. @@ -269,6 +313,7 @@ public ClientMyOrganizationResponseConfiguration build() { userAttributeProfileId, allowedStrategies, connectionDeletionBehavior, + invitationLandingClientId, additionalProperties); } diff --git a/src/main/java/com/auth0/client/mgmt/types/ConnectionOptionsCommonOidc.java b/src/main/java/com/auth0/client/mgmt/types/ConnectionOptionsCommonOidc.java index 98837176..bb79a4a4 100644 --- a/src/main/java/com/auth0/client/mgmt/types/ConnectionOptionsCommonOidc.java +++ b/src/main/java/com/auth0/client/mgmt/types/ConnectionOptionsCommonOidc.java @@ -41,6 +41,8 @@ public final class ConnectionOptionsCommonOidc implements IConnectionOptionsComm private final Optional