provider.coms¶

Provider File¶

oneOf	Email provider
	Email provider
	Communications ASP SMS provider
	Communications ASP SMS provider

Email provider¶

type	object
properties
providerType	type	string
	enum	EMAIL
	default	EMAIL
templateId	The id of the template to use for this file
	type	string
templateVariables	The variables and their values to be replaced from the template
	type	object
	additionalProperties
variablesFiles	The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.
	type	array
	items	type	string
isTemplateGeneratedByOspComposer	If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.
	type	boolean
moduleId	The ID of the linked communications module
	type	string
sendingProtocol	The configuration of the sending protocol
	oneOf	Outgoing Email protocol.
authenticationConfiguration	The type of authentication to connect to the provider
	oneOf	OUTLOOK_OAUTH2
		PASSWORD
		NONE
additionalProperties	False

Outgoing Email protocol.¶

type	object
properties
type	type	string
	enum	SMTP
	default	SMTP
smtpHostServer	The host address where the provider will be connected to.
	type	string
port	The port to which the provider will be connected to.
	type	integer
connectionRetry	The timeout for connection retry.
	default	value	10
		unit	SECONDS
	DurationConfigurationEntity
additionalProperties	False

DurationConfigurationEntity¶

type	object
properties
value	The amount of time expressed with the unit
	type	integer
unit	The unit of time expressed with the value
	type	string
	enum	NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS
additionalProperties	False

OUTLOOK_OAUTH2¶

type	object
properties
type	type	string
	enum	OUTLOOK_OAUTH2
	default	OUTLOOK_OAUTH2
securityType	The type of security used on the connection with the mail server (use : CLEAR for OAUTH2) otherwise probably TLS.
	type	string
	enum	TLS, SSL, CLEAR
	default	CLEAR
username	The username to connect to the SMTP Oauth2 provider.
	type	string
passwordProvider	The password to connect to the SMTP Oauth2 provider.
	oneOf	PLAINTEXT
		SECRET
clientId	The Application (client) ID.
	type	string
authority	The authority refers to the Directory (tenant) ID login url. For example : https://login.microsoftonline.com/{Your Directory (tenant) ID}
	type	string
scope	The scopes are admin defined. If not asked to change, you should let the default one.
	type	array
	default	https://outlook.office365.com/.default
	items	type	string
additionalProperties	False

PLAINTEXT¶

type	object
properties
type	type	string
	enum	PLAINTEXT
	default	PLAINTEXT
password	The password to use in plaintext. It can be for example thisIs@TestPassword123.
	type	string
additionalProperties	False

SECRET¶

type	object
properties
type	type	string
	enum	SECRET
	default	SECRET
secretPath	The path of the secret containing the password. This is a path to the secret containing the password.
	type	string
additionalProperties	False

PASSWORD¶

type	object
properties
type	type	string
	enum	PASSWORD
	default	PASSWORD
securityType	The type of security used on the connection with the mail server (use : CLEAR for OAUTH2) otherwise probably TLS.
	type	string
	enum	TLS, SSL, CLEAR
	default	CLEAR
username	The username to connect to the SMTP provider.
	type	string
passwordProvider	The password to connect to the SMTP provider.
	oneOf	PLAINTEXT
		SECRET
additionalProperties	False

NONE¶

type	object
properties
type	type	string
	enum	NONE
	default	NONE
securityType	The type of security used on the connection with the mail server (use : CLEAR for OAUTH2) otherwise probably TLS.
	type	string
	enum	TLS, SSL, CLEAR
	default	CLEAR
additionalProperties	False

Communications ASP SMS provider¶

type	object
properties
providerType	type	string
	enum	ASPSMS
	default	ASPSMS
templateId	The id of the template to use for this file
	type	string
templateVariables	The variables and their values to be replaced from the template
	type	object
	additionalProperties
variablesFiles	The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.
	type	array
	items	type	string
isTemplateGeneratedByOspComposer	If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.
	type	boolean
moduleId	The ID of the linked communications module
	type	string
username	The username for access to the ASP SMS API.
	type	string
passwordProvider	The password for access to the ASP SMS API.
	oneOf	PLAINTEXT
		SECRET
connectTimeout	The connection timeout to connect to the ASP SMS API
	default	value	10
		unit	SECONDS
	DurationConfigurationEntity
readTimeout	The read timeout (time to answer from the ASP SMS API)
	default	value	10
		unit	SECONDS
	DurationConfigurationEntity
forceGSM7Bit	Force sending GSM7bit characters only to avoid extra cost by accidentally using Unicode Characters.
	type	boolean
	default	True
flashingSMS	The message appears directly on the screen of the mobile phone. A flashing message isn’t saved directly on the mobile phone. The recipient has to choose to save it. Otherwise the message irrevocably disappears from the screen.
	type	boolean
	default	False
additionalProperties	False