REST API for Oracle Analytics Cloud

Configure a mail server

put

/api/20210901/system/mail/server

Configure an email server to deliver reports and visualizations.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Mail server used to deliver visualizations and reports to users by email.

Show Source

auth(required): object Discriminator: authType

Discriminator: { "propertyName":"authType", "mapping":{ "NO_AUTH":"#/components/schemas/MailServerNoAuth", "USERNAME_PASSWORD_AUTH":"#/components/schemas/MailServerUsernamePasswordAuth", "OAUTH2_AUTH":"#/components/schemas/MailServerOAuth2Auth" } }

Mail server authentication type.
connectionSecurity(required): object Discriminator: connectionSecurityType

Discriminator: { "propertyName":"connectionSecurityType", "mapping":{ "NO_CONNECTION_SECURITY":"#/components/schemas/NoConnectionSecurity", "SSL_TLS_CONNECTION_SECURITY":"#/components/schemas/SslTlsConnectionSecurity", "START_TLS_CONNECTION_SECURITY":"#/components/schemas/StartTlsConnectionSecurity" } }

Connection security options for the mail server connection.
host(required): string

Minimum Length: 1

Host name of the SMTP server you want to use to deliver emails. The SMTP server must be accessible from the public internet.
port(required): integer

Minimum Value: 1

Maximum Value: 65535

Port number on the mail server. Common SMTP ports include: 25 (no security), 465 (SSL TLS), 587 (STARTTLS)
sender(required): object MailSender

Sender of emails

{
    "description":"Mail server used to deliver visualizations and reports to users by email.",
    "type":"object",
    "properties":{
        "host":{
            "type":"string",
            "description":"Host name of the SMTP server you want to use to deliver emails. The SMTP server must be accessible from the public internet.",
            "minLength":1
        },
        "port":{
            "type":"integer",
            "description":"Port number on the mail server. Common SMTP ports include: 25 (no security), 465 (SSL TLS), 587 (STARTTLS)",
            "minimum":1,
            "maximum":65535
        },
        "sender":{
            "$ref":"#/components/schemas/MailSender"
        },
        "auth":{
            "$ref":"#/components/schemas/MailServerAuth"
        },
        "connectionSecurity":{
            "$ref":"#/components/schemas/ConnectionSecurity"
        }
    },
    "required":[
        "host",
        "port",
        "sender",
        "auth",
        "connectionSecurity"
    ]
}

Nested Schema : Discriminator: authType

Type: object

Discriminator: authType

{
    "description":"Mail server authentication type.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/MailServerNoAuth"
        },
        {
            "$ref":"#/components/schemas/MailServerUsernamePasswordAuth"
        },
        {
            "$ref":"#/components/schemas/MailServerOAuth2Auth"
        }
    ],
    "discriminator":{
        "propertyName":"authType",
        "mapping":{
            "NO_AUTH":"#/components/schemas/MailServerNoAuth",
            "USERNAME_PASSWORD_AUTH":"#/components/schemas/MailServerUsernamePasswordAuth",
            "OAUTH2_AUTH":"#/components/schemas/MailServerOAuth2Auth"
        }
    }
}

Mail server authentication type.

Match One Schema

Show Source

NO_AUTH - object MailServerNoAuth

Mail server doesn???t require authentication.
USERNAME_PASSWORD_AUTH - object MailServerUsernamePasswordAuth

Mail server authentication requires a username and password.
OAUTH2_AUTH - object MailServerOAuth2Auth

Mail server authentication uses OAuth2

{
    "description":"Mail server authentication type.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/MailServerNoAuth"
        },
        {
            "$ref":"#/components/schemas/MailServerUsernamePasswordAuth"
        },
        {
            "$ref":"#/components/schemas/MailServerOAuth2Auth"
        }
    ],
    "discriminator":{
        "propertyName":"authType",
        "mapping":{
            "NO_AUTH":"#/components/schemas/MailServerNoAuth",
            "USERNAME_PASSWORD_AUTH":"#/components/schemas/MailServerUsernamePasswordAuth",
            "OAUTH2_AUTH":"#/components/schemas/MailServerOAuth2Auth"
        }
    }
}

Nested Schema : Discriminator: connectionSecurityType

Type: object

Discriminator: connectionSecurityType

Discriminator Values

NO_CONNECTION_SECURITY
SSL_TLS_CONNECTION_SECURITY
START_TLS_CONNECTION_SECURITY

{
    "description":"Connection security options for the mail server connection.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/NoConnectionSecurity"
        },
        {
            "$ref":"#/components/schemas/SslTlsConnectionSecurity"
        },
        {
            "$ref":"#/components/schemas/StartTlsConnectionSecurity"
        }
    ],
    "discriminator":{
        "propertyName":"connectionSecurityType",
        "mapping":{
            "NO_CONNECTION_SECURITY":"#/components/schemas/NoConnectionSecurity",
            "SSL_TLS_CONNECTION_SECURITY":"#/components/schemas/SslTlsConnectionSecurity",
            "START_TLS_CONNECTION_SECURITY":"#/components/schemas/StartTlsConnectionSecurity"
        }
    }
}

Connection security options for the mail server connection.

Match One Schema

Show Source

NO_CONNECTION_SECURITY - object NoConnectionSecurity

No conection security.
SSL_TLS_CONNECTION_SECURITY - object SslTlsConnectionSecurity

SSL TLS security for the mail server connection.
START_TLS_CONNECTION_SECURITY - object StartTlsConnectionSecurity

STARTTLS security for the mail server connection.

{
    "description":"Connection security options for the mail server connection.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/NoConnectionSecurity"
        },
        {
            "$ref":"#/components/schemas/SslTlsConnectionSecurity"
        },
        {
            "$ref":"#/components/schemas/StartTlsConnectionSecurity"
        }
    ],
    "discriminator":{
        "propertyName":"connectionSecurityType",
        "mapping":{
            "NO_CONNECTION_SECURITY":"#/components/schemas/NoConnectionSecurity",
            "SSL_TLS_CONNECTION_SECURITY":"#/components/schemas/SslTlsConnectionSecurity",
            "START_TLS_CONNECTION_SECURITY":"#/components/schemas/StartTlsConnectionSecurity"
        }
    }
}

Nested Schema : MailSender

Type: object

Sender of emails

Show Source

displayName(required): string

Minimum Length: 1

Name displayed in the 'From' field of emails delivering reports.
emailAddress(required): string

Minimum Length: 1

Email address displayed in the 'From' field of emails delivering reports.

{
    "description":"Sender of emails",
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"Name displayed in the 'From' field of emails delivering reports.",
            "minLength":1
        },
        "emailAddress":{
            "type":"string",
            "description":"Email address displayed in the 'From' field of emails delivering reports.",
            "minLength":1
        }
    },
    "required":[
        "displayName",
        "emailAddress"
    ]
}

Nested Schema : MailServerNoAuth

Type: object

Mail server doesn???t require authentication.

Show Source

authType(required): authType

No authentication type

{
    "description":"Mail server doesn???t require authentication.",
    "type":"object",
    "properties":{
        "authType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/MailServerAuthType"
                }
            ],
            "description":"No authentication type",
            "default":"NO_AUTH"
        }
    },
    "required":[
        "authType"
    ]
}

Nested Schema : MailServerUsernamePasswordAuth

Type: object

Mail server authentication requires a username and password.

Show Source

authType(required): authType

Username and password required for authentication.
password(required): string

Minimum Length: 8

Maximum Length: 255

Password to authenticate access to the mail server.
username(required): string

Minimum Length: 1

Username to authenticate access to the mail server.

{
    "description":"Mail server authentication requires a username and password.",
    "type":"object",
    "properties":{
        "authType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/MailServerAuthType"
                }
            ],
            "description":"Username and password required for authentication.",
            "default":"USERNAME_PASSWORD_AUTH"
        },
        "username":{
            "type":"string",
            "description":"Username to authenticate access to the mail server.",
            "minLength":1
        },
        "password":{
            "type":"string",
            "description":"Password to authenticate access to the mail server.",
            "minLength":8,
            "maxLength":255,
            "writeOnly":true
        }
    },
    "required":[
        "authType",
        "username",
        "password"
    ]
}

Nested Schema : MailServerOAuth2Auth

Type: object

Mail server authentication uses OAuth2

Show Source

authType: authType

OAuth2 AuthType
oAuth2Details(required): object Discriminator: oAuth2Provider

Discriminator: { "propertyName":"oAuth2Provider", "mapping":{ "MS_OAUTH2":"#/components/schemas/MailServerMSOAuth2" } }

Configuration details for a specific OAuth2 provider.

{
    "description":"Mail server authentication uses OAuth2",
    "type":"object",
    "properties":{
        "authType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/AuthType"
                }
            ],
            "description":"OAuth2 AuthType",
            "default":"OAUTH2_AUTH"
        },
        "oAuth2Details":{
            "$ref":"#/components/schemas/MailServerOAuth2Details"
        }
    },
    "required":[
        "oAuth2Details"
    ]
}

Nested Schema : authType

No authentication type

Default Value: NO_AUTH

Match All

No authentication type

Show Source

string

Allowed Values: [ "NO_AUTH", "USERNAME_PASSWORD_AUTH", "OAUTH2_AUTH" ]

Type of authentication the mail server requires.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/MailServerAuthType"
        }
    ],
    "description":"No authentication type",
    "default":"NO_AUTH"
}

Nested Schema : authType

Username and password required for authentication.

Default Value: USERNAME_PASSWORD_AUTH

Match All

Username and password required for authentication.

Show Source

string

Allowed Values: [ "NO_AUTH", "USERNAME_PASSWORD_AUTH", "OAUTH2_AUTH" ]

Type of authentication the mail server requires.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/MailServerAuthType"
        }
    ],
    "description":"Username and password required for authentication.",
    "default":"USERNAME_PASSWORD_AUTH"
}

Nested Schema : authType

OAuth2 AuthType

Default Value: OAUTH2_AUTH

Match All

OAuth2 AuthType

Show Source

string

Allowed Values: [ "OSS_AUTH_OCI_USER_ID", "OCI_RESOURCE_PRINCIPAL" ]

Type of authentication.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AuthType"
        }
    ],
    "description":"OAuth2 AuthType",
    "default":"OAUTH2_AUTH"
}

Nested Schema : Discriminator: oAuth2Provider

Type: object

Discriminator: oAuth2Provider

Discriminator Values

MS_OAUTH2

{
    "description":"Configuration details for a specific OAuth2 provider.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/MailServerMSOAuth2"
        }
    ],
    "discriminator":{
        "propertyName":"oAuth2Provider",
        "mapping":{
            "MS_OAUTH2":"#/components/schemas/MailServerMSOAuth2"
        }
    }
}

Configuration details for a specific OAuth2 provider.

Match One Schema

Show Source

MS_OAUTH2 - object MailServerMSOAuth2

Mail server authentication that uses the Microsoft OAuth2 client credential flow.

{
    "description":"Configuration details for a specific OAuth2 provider.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/MailServerMSOAuth2"
        }
    ],
    "discriminator":{
        "propertyName":"oAuth2Provider",
        "mapping":{
            "MS_OAUTH2":"#/components/schemas/MailServerMSOAuth2"
        }
    }
}

Nested Schema : MailServerMSOAuth2

Type: object

Mail server authentication that uses the Microsoft OAuth2 client credential flow.

Show Source

clientId(required): string

Minimum Length: 1

Maximum Length: 255

OAuth2 client ID required to authenticate access to the mail server.
oAuth2Provider: oAuth2Provider

Specific OAuth2 AuthType
secret(required): string

Minimum Length: 8

Maximum Length: 255

OAuth2 client secret required to authenticate access to the mail server.
tenant(required): string

Minimum Length: 1

Maximum Length: 255

OAuth2 tenant required to authenticate to access the mail server.
username(required): string

Minimum Length: 1

Username required to authenticate to the mail server. Any valid user with access to the mail server.

{
    "description":"Mail server authentication that uses the Microsoft OAuth2 client credential flow.",
    "type":"object",
    "properties":{
        "oAuth2Provider":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/MailServerOAuth2Provider"
                }
            ],
            "description":"Specific OAuth2 AuthType",
            "default":"MS_OAUTH2"
        },
        "username":{
            "type":"string",
            "description":"Username required to authenticate to the mail server. Any valid user with access to the mail server.",
            "minLength":1
        },
        "clientId":{
            "type":"string",
            "description":"OAuth2 client ID required to authenticate access to the mail server.",
            "minLength":1,
            "maxLength":255
        },
        "secret":{
            "type":"string",
            "description":"OAuth2 client secret required to authenticate access to the mail server.",
            "minLength":8,
            "maxLength":255,
            "writeOnly":true
        },
        "tenant":{
            "type":"string",
            "description":"OAuth2 tenant required to authenticate to access the mail server.",
            "minLength":1,
            "maxLength":255
        }
    },
    "required":[
        "username",
        "clientId",
        "secret",
        "tenant"
    ]
}

Nested Schema : oAuth2Provider

Specific OAuth2 AuthType

Default Value: MS_OAUTH2

Match All

Specific OAuth2 AuthType

Show Source

string

Allowed Values: [ "MS_OAUTH2" ]

OAuth2 services provider.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/MailServerOAuth2Provider"
        }
    ],
    "description":"Specific OAuth2 AuthType",
    "default":"MS_OAUTH2"
}

Nested Schema : NoConnectionSecurity

Type: object

No conection security.

Show Source

connectionSecurityType(required): connectionSecurityType

No connection security.

{
    "description":"No conection security.",
    "type":"object",
    "properties":{
        "connectionSecurityType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ConnectionSecurityType"
                }
            ],
            "description":"No connection security.",
            "default":"NO_CONNECTION_SECURITY"
        }
    },
    "required":[
        "connectionSecurityType"
    ]
}

Nested Schema : SslTlsConnectionSecurity

Type: object

SSL TLS security for the mail server connection.

Show Source

connectionSecurityType(required): connectionSecurityType

SSL TLS connection security.
tlsCertificateDetails(required): object Discriminator: certificateType

Discriminator: { "propertyName":"certificateType", "mapping":{ "DEFAULT_TLS_CERTIFICATE":"#/components/schemas/DefaultTlsCertificate", "CUSTOM_TLS_CERTIFICATE":"#/components/schemas/CustomTlsCertificate" } }

Certificate for SSL TLS or START TLS connection security.

{
    "description":"SSL TLS security for the mail server connection.",
    "type":"object",
    "properties":{
        "connectionSecurityType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ConnectionSecurityType"
                }
            ],
            "description":"SSL TLS connection security.",
            "default":"SSL_TLS_CONNECTION_SECURITY"
        },
        "tlsCertificateDetails":{
            "$ref":"#/components/schemas/TlsCertificateDetails"
        }
    },
    "required":[
        "connectionSecurityType",
        "tlsCertificateDetails"
    ]
}

Nested Schema : StartTlsConnectionSecurity

Type: object

STARTTLS security for the mail server connection.

Show Source

connectionSecurityType(required): connectionSecurityType

STARTTLS connection security.
tlsCertificateDetails(required): object Discriminator: certificateType

Discriminator: { "propertyName":"certificateType", "mapping":{ "DEFAULT_TLS_CERTIFICATE":"#/components/schemas/DefaultTlsCertificate", "CUSTOM_TLS_CERTIFICATE":"#/components/schemas/CustomTlsCertificate" } }

Certificate for SSL TLS or START TLS connection security.

{
    "description":"STARTTLS security for the mail server connection.",
    "type":"object",
    "properties":{
        "connectionSecurityType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ConnectionSecurityType"
                }
            ],
            "description":"STARTTLS connection security.",
            "default":"START_TLS_CONNECTION_SECURITY"
        },
        "tlsCertificateDetails":{
            "$ref":"#/components/schemas/TlsCertificateDetails"
        }
    },
    "required":[
        "connectionSecurityType",
        "tlsCertificateDetails"
    ]
}

Nested Schema : connectionSecurityType

No connection security.

Default Value: NO_CONNECTION_SECURITY

Match All

No connection security.

Show Source

string

Allowed Values: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

Type of security on the mail server connection.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ConnectionSecurityType"
        }
    ],
    "description":"No connection security.",
    "default":"NO_CONNECTION_SECURITY"
}

Nested Schema : connectionSecurityType

SSL TLS connection security.

Default Value: SSL_TLS_CONNECTION_SECURITY

Match All

SSL TLS connection security.

Show Source

string

Allowed Values: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

Type of security on the mail server connection.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ConnectionSecurityType"
        }
    ],
    "description":"SSL TLS connection security.",
    "default":"SSL_TLS_CONNECTION_SECURITY"
}

Nested Schema : Discriminator: certificateType

Type: object

Discriminator: certificateType

Discriminator Values

DEFAULT_TLS_CERTIFICATE
CUSTOM_TLS_CERTIFICATE

{
    "description":"Certificate for SSL TLS or START TLS connection security.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/DefaultTlsCertificate"
        },
        {
            "$ref":"#/components/schemas/CustomTlsCertificate"
        }
    ],
    "discriminator":{
        "propertyName":"certificateType",
        "mapping":{
            "DEFAULT_TLS_CERTIFICATE":"#/components/schemas/DefaultTlsCertificate",
            "CUSTOM_TLS_CERTIFICATE":"#/components/schemas/CustomTlsCertificate"
        }
    }
}

Certificate for SSL TLS or START TLS connection security.

Match One Schema

Show Source

DEFAULT_TLS_CERTIFICATE - object DefaultTlsCertificate

Use the default certificate provided for an SSL-enabled mail server.
CUSTOM_TLS_CERTIFICATE - object CustomTlsCertificate

Use a custom TLS certificate for an SSL-enabled mail server.

{
    "description":"Certificate for SSL TLS or START TLS connection security.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/DefaultTlsCertificate"
        },
        {
            "$ref":"#/components/schemas/CustomTlsCertificate"
        }
    ],
    "discriminator":{
        "propertyName":"certificateType",
        "mapping":{
            "DEFAULT_TLS_CERTIFICATE":"#/components/schemas/DefaultTlsCertificate",
            "CUSTOM_TLS_CERTIFICATE":"#/components/schemas/CustomTlsCertificate"
        }
    }
}

Nested Schema : DefaultTlsCertificate

Type: object

Use the default certificate provided for an SSL-enabled mail server.

Show Source

certificateType(required): certificateType

Use the mail server???s default TLS certificate.

{
    "description":"Use the default certificate provided for an SSL-enabled mail server.",
    "type":"object",
    "properties":{
        "certificateType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CertificateType"
                }
            ],
            "description":"Use the mail server???s default TLS certificate.",
            "default":"DEFAULT_TLS_CERTIFICATE"
        }
    },
    "required":[
        "certificateType"
    ]
}

Nested Schema : CustomTlsCertificate

Type: object

Use a custom TLS certificate for an SSL-enabled mail server.

Show Source

certificate(required): string

The certificate for an SSL enabled MailServer
certificateType(required): certificateType

CustomTlsCertificate CertificateType

{
    "description":"Use a custom TLS certificate for an SSL-enabled mail server.",
    "type":"object",
    "properties":{
        "certificateType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CertificateType"
                }
            ],
            "description":"CustomTlsCertificate CertificateType",
            "default":"CUSTOM_TLS_CERTIFICATE"
        },
        "certificate":{
            "type":"string",
            "description":"The certificate for an SSL enabled MailServer",
            "writeOnly":true
        }
    },
    "required":[
        "certificateType",
        "certificate"
    ]
}

Nested Schema : certificateType

Use the mail server???s default TLS certificate.

Default Value: DEFAULT_TLS_CERTIFICATE

Match All

Use the mail server???s default TLS certificate.

Show Source

string

Allowed Values: [ "DEFAULT_TLS_CERTIFICATE", "CUSTOM_TLS_CERTIFICATE" ]

Type of TLS certificate, default or custom.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CertificateType"
        }
    ],
    "description":"Use the mail server???s default TLS certificate.",
    "default":"DEFAULT_TLS_CERTIFICATE"
}

Nested Schema : certificateType

CustomTlsCertificate CertificateType

Default Value: CUSTOM_TLS_CERTIFICATE

Match All

CustomTlsCertificate CertificateType

Show Source

string

Allowed Values: [ "DEFAULT_TLS_CERTIFICATE", "CUSTOM_TLS_CERTIFICATE" ]

Type of TLS certificate, default or custom.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CertificateType"
        }
    ],
    "description":"CustomTlsCertificate CertificateType",
    "default":"CUSTOM_TLS_CERTIFICATE"
}

Nested Schema : connectionSecurityType

STARTTLS connection security.

Default Value: START_TLS_CONNECTION_SECURITY

Match All

STARTTLS connection security.

Show Source

string

Allowed Values: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

Type of security on the mail server connection.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ConnectionSecurityType"
        }
    ],
    "description":"STARTTLS connection security.",
    "default":"START_TLS_CONNECTION_SECURITY"
}

Response

Supported Media Types

application/json

200 Response

Mail server successfully configured.

Root Schema : schema

Type: object

Mail server used to deliver visualizations and reports to users by email.

Show Source

auth(required): object Discriminator: authType

Discriminator: { "propertyName":"authType", "mapping":{ "NO_AUTH":"#/components/schemas/MailServerNoAuth", "USERNAME_PASSWORD_AUTH":"#/components/schemas/MailServerUsernamePasswordAuth", "OAUTH2_AUTH":"#/components/schemas/MailServerOAuth2Auth" } }

Mail server authentication type.
connectionSecurity(required): object Discriminator: connectionSecurityType

Discriminator: { "propertyName":"connectionSecurityType", "mapping":{ "NO_CONNECTION_SECURITY":"#/components/schemas/NoConnectionSecurity", "SSL_TLS_CONNECTION_SECURITY":"#/components/schemas/SslTlsConnectionSecurity", "START_TLS_CONNECTION_SECURITY":"#/components/schemas/StartTlsConnectionSecurity" } }

Connection security options for the mail server connection.
host(required): string

Minimum Length: 1

Host name of the SMTP server you want to use to deliver emails. The SMTP server must be accessible from the public internet.
port(required): integer

Minimum Value: 1

Maximum Value: 65535

Port number on the mail server. Common SMTP ports include: 25 (no security), 465 (SSL TLS), 587 (STARTTLS)
sender(required): object MailSender

Sender of emails

{
    "description":"Mail server used to deliver visualizations and reports to users by email.",
    "type":"object",
    "properties":{
        "host":{
            "type":"string",
            "description":"Host name of the SMTP server you want to use to deliver emails. The SMTP server must be accessible from the public internet.",
            "minLength":1
        },
        "port":{
            "type":"integer",
            "description":"Port number on the mail server. Common SMTP ports include: 25 (no security), 465 (SSL TLS), 587 (STARTTLS)",
            "minimum":1,
            "maximum":65535
        },
        "sender":{
            "$ref":"#/components/schemas/MailSender"
        },
        "auth":{
            "$ref":"#/components/schemas/MailServerAuth"
        },
        "connectionSecurity":{
            "$ref":"#/components/schemas/ConnectionSecurity"
        }
    },
    "required":[
        "host",
        "port",
        "sender",
        "auth",
        "connectionSecurity"
    ]
}

Nested Schema : Discriminator: authType

Type: object

Discriminator: authType

Discriminator Values

NO_AUTH
USERNAME_PASSWORD_AUTH
OAUTH2_AUTH

{
    "description":"Mail server authentication type.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/MailServerNoAuth"
        },
        {
            "$ref":"#/components/schemas/MailServerUsernamePasswordAuth"
        },
        {
            "$ref":"#/components/schemas/MailServerOAuth2Auth"
        }
    ],
    "discriminator":{
        "propertyName":"authType",
        "mapping":{
            "NO_AUTH":"#/components/schemas/MailServerNoAuth",
            "USERNAME_PASSWORD_AUTH":"#/components/schemas/MailServerUsernamePasswordAuth",
            "OAUTH2_AUTH":"#/components/schemas/MailServerOAuth2Auth"
        }
    }
}

Mail server authentication type.

Match One Schema

Show Source

NO_AUTH - object MailServerNoAuth

Mail server doesn???t require authentication.
USERNAME_PASSWORD_AUTH - object MailServerUsernamePasswordAuth

Mail server authentication requires a username and password.
OAUTH2_AUTH - object MailServerOAuth2Auth

Mail server authentication uses OAuth2

{
    "description":"Mail server authentication type.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/MailServerNoAuth"
        },
        {
            "$ref":"#/components/schemas/MailServerUsernamePasswordAuth"
        },
        {
            "$ref":"#/components/schemas/MailServerOAuth2Auth"
        }
    ],
    "discriminator":{
        "propertyName":"authType",
        "mapping":{
            "NO_AUTH":"#/components/schemas/MailServerNoAuth",
            "USERNAME_PASSWORD_AUTH":"#/components/schemas/MailServerUsernamePasswordAuth",
            "OAUTH2_AUTH":"#/components/schemas/MailServerOAuth2Auth"
        }
    }
}

Nested Schema : Discriminator: connectionSecurityType

Type: object

Discriminator: connectionSecurityType

Discriminator Values

NO_CONNECTION_SECURITY
SSL_TLS_CONNECTION_SECURITY
START_TLS_CONNECTION_SECURITY

{
    "description":"Connection security options for the mail server connection.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/NoConnectionSecurity"
        },
        {
            "$ref":"#/components/schemas/SslTlsConnectionSecurity"
        },
        {
            "$ref":"#/components/schemas/StartTlsConnectionSecurity"
        }
    ],
    "discriminator":{
        "propertyName":"connectionSecurityType",
        "mapping":{
            "NO_CONNECTION_SECURITY":"#/components/schemas/NoConnectionSecurity",
            "SSL_TLS_CONNECTION_SECURITY":"#/components/schemas/SslTlsConnectionSecurity",
            "START_TLS_CONNECTION_SECURITY":"#/components/schemas/StartTlsConnectionSecurity"
        }
    }
}

Connection security options for the mail server connection.

Match One Schema

Show Source

NO_CONNECTION_SECURITY - object NoConnectionSecurity

No conection security.
SSL_TLS_CONNECTION_SECURITY - object SslTlsConnectionSecurity

SSL TLS security for the mail server connection.
START_TLS_CONNECTION_SECURITY - object StartTlsConnectionSecurity

STARTTLS security for the mail server connection.

{
    "description":"Connection security options for the mail server connection.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/NoConnectionSecurity"
        },
        {
            "$ref":"#/components/schemas/SslTlsConnectionSecurity"
        },
        {
            "$ref":"#/components/schemas/StartTlsConnectionSecurity"
        }
    ],
    "discriminator":{
        "propertyName":"connectionSecurityType",
        "mapping":{
            "NO_CONNECTION_SECURITY":"#/components/schemas/NoConnectionSecurity",
            "SSL_TLS_CONNECTION_SECURITY":"#/components/schemas/SslTlsConnectionSecurity",
            "START_TLS_CONNECTION_SECURITY":"#/components/schemas/StartTlsConnectionSecurity"
        }
    }
}

Nested Schema : MailSender

Type: object

Sender of emails

Show Source

displayName(required): string

Minimum Length: 1

Name displayed in the 'From' field of emails delivering reports.
emailAddress(required): string

Minimum Length: 1

Email address displayed in the 'From' field of emails delivering reports.

{
    "description":"Sender of emails",
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"Name displayed in the 'From' field of emails delivering reports.",
            "minLength":1
        },
        "emailAddress":{
            "type":"string",
            "description":"Email address displayed in the 'From' field of emails delivering reports.",
            "minLength":1
        }
    },
    "required":[
        "displayName",
        "emailAddress"
    ]
}

Nested Schema : MailServerNoAuth

Type: object

Mail server doesn???t require authentication.

Show Source

authType(required): authType

No authentication type

{
    "description":"Mail server doesn???t require authentication.",
    "type":"object",
    "properties":{
        "authType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/MailServerAuthType"
                }
            ],
            "description":"No authentication type",
            "default":"NO_AUTH"
        }
    },
    "required":[
        "authType"
    ]
}

Nested Schema : MailServerUsernamePasswordAuth

Type: object

Mail server authentication requires a username and password.

Show Source

authType(required): authType

Username and password required for authentication.
password(required): string

Minimum Length: 8

Maximum Length: 255

Password to authenticate access to the mail server.
username(required): string

Minimum Length: 1

Username to authenticate access to the mail server.

{
    "description":"Mail server authentication requires a username and password.",
    "type":"object",
    "properties":{
        "authType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/MailServerAuthType"
                }
            ],
            "description":"Username and password required for authentication.",
            "default":"USERNAME_PASSWORD_AUTH"
        },
        "username":{
            "type":"string",
            "description":"Username to authenticate access to the mail server.",
            "minLength":1
        },
        "password":{
            "type":"string",
            "description":"Password to authenticate access to the mail server.",
            "minLength":8,
            "maxLength":255,
            "writeOnly":true
        }
    },
    "required":[
        "authType",
        "username",
        "password"
    ]
}

Nested Schema : MailServerOAuth2Auth

Type: object

Mail server authentication uses OAuth2

Show Source

authType: authType

OAuth2 AuthType
oAuth2Details(required): object Discriminator: oAuth2Provider

Discriminator: { "propertyName":"oAuth2Provider", "mapping":{ "MS_OAUTH2":"#/components/schemas/MailServerMSOAuth2" } }

Configuration details for a specific OAuth2 provider.

{
    "description":"Mail server authentication uses OAuth2",
    "type":"object",
    "properties":{
        "authType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/AuthType"
                }
            ],
            "description":"OAuth2 AuthType",
            "default":"OAUTH2_AUTH"
        },
        "oAuth2Details":{
            "$ref":"#/components/schemas/MailServerOAuth2Details"
        }
    },
    "required":[
        "oAuth2Details"
    ]
}

Nested Schema : authType

No authentication type

Default Value: NO_AUTH

Match All

No authentication type

Show Source

string

Allowed Values: [ "NO_AUTH", "USERNAME_PASSWORD_AUTH", "OAUTH2_AUTH" ]

Type of authentication the mail server requires.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/MailServerAuthType"
        }
    ],
    "description":"No authentication type",
    "default":"NO_AUTH"
}

Nested Schema : authType

Username and password required for authentication.

Default Value: USERNAME_PASSWORD_AUTH

Match All

Username and password required for authentication.

Show Source

string

Allowed Values: [ "NO_AUTH", "USERNAME_PASSWORD_AUTH", "OAUTH2_AUTH" ]

Type of authentication the mail server requires.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/MailServerAuthType"
        }
    ],
    "description":"Username and password required for authentication.",
    "default":"USERNAME_PASSWORD_AUTH"
}

Nested Schema : authType

OAuth2 AuthType

Default Value: OAUTH2_AUTH

Match All

OAuth2 AuthType

Show Source

string

Allowed Values: [ "OSS_AUTH_OCI_USER_ID", "OCI_RESOURCE_PRINCIPAL" ]

Type of authentication.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AuthType"
        }
    ],
    "description":"OAuth2 AuthType",
    "default":"OAUTH2_AUTH"
}

Nested Schema : Discriminator: oAuth2Provider

Type: object

Discriminator: oAuth2Provider

Discriminator Values

MS_OAUTH2

{
    "description":"Configuration details for a specific OAuth2 provider.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/MailServerMSOAuth2"
        }
    ],
    "discriminator":{
        "propertyName":"oAuth2Provider",
        "mapping":{
            "MS_OAUTH2":"#/components/schemas/MailServerMSOAuth2"
        }
    }
}

Configuration details for a specific OAuth2 provider.

Match One Schema

Show Source

MS_OAUTH2 - object MailServerMSOAuth2

Mail server authentication that uses the Microsoft OAuth2 client credential flow.

{
    "description":"Configuration details for a specific OAuth2 provider.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/MailServerMSOAuth2"
        }
    ],
    "discriminator":{
        "propertyName":"oAuth2Provider",
        "mapping":{
            "MS_OAUTH2":"#/components/schemas/MailServerMSOAuth2"
        }
    }
}

Nested Schema : MailServerMSOAuth2

Type: object

Mail server authentication that uses the Microsoft OAuth2 client credential flow.

Show Source

clientId(required): string

Minimum Length: 1

Maximum Length: 255

OAuth2 client ID required to authenticate access to the mail server.
oAuth2Provider: oAuth2Provider

Specific OAuth2 AuthType
secret(required): string

Minimum Length: 8

Maximum Length: 255

OAuth2 client secret required to authenticate access to the mail server.
tenant(required): string

Minimum Length: 1

Maximum Length: 255

OAuth2 tenant required to authenticate to access the mail server.
username(required): string

Minimum Length: 1

Username required to authenticate to the mail server. Any valid user with access to the mail server.

{
    "description":"Mail server authentication that uses the Microsoft OAuth2 client credential flow.",
    "type":"object",
    "properties":{
        "oAuth2Provider":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/MailServerOAuth2Provider"
                }
            ],
            "description":"Specific OAuth2 AuthType",
            "default":"MS_OAUTH2"
        },
        "username":{
            "type":"string",
            "description":"Username required to authenticate to the mail server. Any valid user with access to the mail server.",
            "minLength":1
        },
        "clientId":{
            "type":"string",
            "description":"OAuth2 client ID required to authenticate access to the mail server.",
            "minLength":1,
            "maxLength":255
        },
        "secret":{
            "type":"string",
            "description":"OAuth2 client secret required to authenticate access to the mail server.",
            "minLength":8,
            "maxLength":255,
            "writeOnly":true
        },
        "tenant":{
            "type":"string",
            "description":"OAuth2 tenant required to authenticate to access the mail server.",
            "minLength":1,
            "maxLength":255
        }
    },
    "required":[
        "username",
        "clientId",
        "secret",
        "tenant"
    ]
}

Nested Schema : oAuth2Provider

Specific OAuth2 AuthType

Default Value: MS_OAUTH2

Match All

Specific OAuth2 AuthType

Show Source

string

Allowed Values: [ "MS_OAUTH2" ]

OAuth2 services provider.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/MailServerOAuth2Provider"
        }
    ],
    "description":"Specific OAuth2 AuthType",
    "default":"MS_OAUTH2"
}

Nested Schema : NoConnectionSecurity

Type: object

No conection security.

Show Source

connectionSecurityType(required): connectionSecurityType

No connection security.

{
    "description":"No conection security.",
    "type":"object",
    "properties":{
        "connectionSecurityType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ConnectionSecurityType"
                }
            ],
            "description":"No connection security.",
            "default":"NO_CONNECTION_SECURITY"
        }
    },
    "required":[
        "connectionSecurityType"
    ]
}

Nested Schema : SslTlsConnectionSecurity

Type: object

SSL TLS security for the mail server connection.

Show Source

connectionSecurityType(required): connectionSecurityType

SSL TLS connection security.
tlsCertificateDetails(required): object Discriminator: certificateType

Discriminator: { "propertyName":"certificateType", "mapping":{ "DEFAULT_TLS_CERTIFICATE":"#/components/schemas/DefaultTlsCertificate", "CUSTOM_TLS_CERTIFICATE":"#/components/schemas/CustomTlsCertificate" } }

Certificate for SSL TLS or START TLS connection security.

{
    "description":"SSL TLS security for the mail server connection.",
    "type":"object",
    "properties":{
        "connectionSecurityType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ConnectionSecurityType"
                }
            ],
            "description":"SSL TLS connection security.",
            "default":"SSL_TLS_CONNECTION_SECURITY"
        },
        "tlsCertificateDetails":{
            "$ref":"#/components/schemas/TlsCertificateDetails"
        }
    },
    "required":[
        "connectionSecurityType",
        "tlsCertificateDetails"
    ]
}

Nested Schema : StartTlsConnectionSecurity

Type: object

STARTTLS security for the mail server connection.

Show Source

connectionSecurityType(required): connectionSecurityType

STARTTLS connection security.
tlsCertificateDetails(required): object Discriminator: certificateType

Discriminator: { "propertyName":"certificateType", "mapping":{ "DEFAULT_TLS_CERTIFICATE":"#/components/schemas/DefaultTlsCertificate", "CUSTOM_TLS_CERTIFICATE":"#/components/schemas/CustomTlsCertificate" } }

Certificate for SSL TLS or START TLS connection security.

{
    "description":"STARTTLS security for the mail server connection.",
    "type":"object",
    "properties":{
        "connectionSecurityType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ConnectionSecurityType"
                }
            ],
            "description":"STARTTLS connection security.",
            "default":"START_TLS_CONNECTION_SECURITY"
        },
        "tlsCertificateDetails":{
            "$ref":"#/components/schemas/TlsCertificateDetails"
        }
    },
    "required":[
        "connectionSecurityType",
        "tlsCertificateDetails"
    ]
}

Nested Schema : connectionSecurityType

No connection security.

Default Value: NO_CONNECTION_SECURITY

Match All

No connection security.

Show Source

string

Allowed Values: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

Type of security on the mail server connection.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ConnectionSecurityType"
        }
    ],
    "description":"No connection security.",
    "default":"NO_CONNECTION_SECURITY"
}

Nested Schema : connectionSecurityType

SSL TLS connection security.

Default Value: SSL_TLS_CONNECTION_SECURITY

Match All

SSL TLS connection security.

Show Source

string

Allowed Values: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

Type of security on the mail server connection.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ConnectionSecurityType"
        }
    ],
    "description":"SSL TLS connection security.",
    "default":"SSL_TLS_CONNECTION_SECURITY"
}

Nested Schema : Discriminator: certificateType

Type: object

Discriminator: certificateType

Discriminator Values

DEFAULT_TLS_CERTIFICATE
CUSTOM_TLS_CERTIFICATE

{
    "description":"Certificate for SSL TLS or START TLS connection security.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/DefaultTlsCertificate"
        },
        {
            "$ref":"#/components/schemas/CustomTlsCertificate"
        }
    ],
    "discriminator":{
        "propertyName":"certificateType",
        "mapping":{
            "DEFAULT_TLS_CERTIFICATE":"#/components/schemas/DefaultTlsCertificate",
            "CUSTOM_TLS_CERTIFICATE":"#/components/schemas/CustomTlsCertificate"
        }
    }
}

Certificate for SSL TLS or START TLS connection security.

Match One Schema

Show Source

DEFAULT_TLS_CERTIFICATE - object DefaultTlsCertificate

Use the default certificate provided for an SSL-enabled mail server.
CUSTOM_TLS_CERTIFICATE - object CustomTlsCertificate

Use a custom TLS certificate for an SSL-enabled mail server.

{
    "description":"Certificate for SSL TLS or START TLS connection security.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/DefaultTlsCertificate"
        },
        {
            "$ref":"#/components/schemas/CustomTlsCertificate"
        }
    ],
    "discriminator":{
        "propertyName":"certificateType",
        "mapping":{
            "DEFAULT_TLS_CERTIFICATE":"#/components/schemas/DefaultTlsCertificate",
            "CUSTOM_TLS_CERTIFICATE":"#/components/schemas/CustomTlsCertificate"
        }
    }
}

Nested Schema : DefaultTlsCertificate

Type: object

Use the default certificate provided for an SSL-enabled mail server.

Show Source

certificateType(required): certificateType

Use the mail server???s default TLS certificate.

{
    "description":"Use the default certificate provided for an SSL-enabled mail server.",
    "type":"object",
    "properties":{
        "certificateType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CertificateType"
                }
            ],
            "description":"Use the mail server???s default TLS certificate.",
            "default":"DEFAULT_TLS_CERTIFICATE"
        }
    },
    "required":[
        "certificateType"
    ]
}

Nested Schema : CustomTlsCertificate

Type: object

Use a custom TLS certificate for an SSL-enabled mail server.

Show Source

certificate(required): string

The certificate for an SSL enabled MailServer
certificateType(required): certificateType

CustomTlsCertificate CertificateType

{
    "description":"Use a custom TLS certificate for an SSL-enabled mail server.",
    "type":"object",
    "properties":{
        "certificateType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CertificateType"
                }
            ],
            "description":"CustomTlsCertificate CertificateType",
            "default":"CUSTOM_TLS_CERTIFICATE"
        },
        "certificate":{
            "type":"string",
            "description":"The certificate for an SSL enabled MailServer",
            "writeOnly":true
        }
    },
    "required":[
        "certificateType",
        "certificate"
    ]
}

Nested Schema : certificateType

Use the mail server???s default TLS certificate.

Default Value: DEFAULT_TLS_CERTIFICATE

Match All

Use the mail server???s default TLS certificate.

Show Source

string

Allowed Values: [ "DEFAULT_TLS_CERTIFICATE", "CUSTOM_TLS_CERTIFICATE" ]

Type of TLS certificate, default or custom.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CertificateType"
        }
    ],
    "description":"Use the mail server???s default TLS certificate.",
    "default":"DEFAULT_TLS_CERTIFICATE"
}

Nested Schema : certificateType

CustomTlsCertificate CertificateType

Default Value: CUSTOM_TLS_CERTIFICATE

Match All

CustomTlsCertificate CertificateType

Show Source

string

Allowed Values: [ "DEFAULT_TLS_CERTIFICATE", "CUSTOM_TLS_CERTIFICATE" ]

Type of TLS certificate, default or custom.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CertificateType"
        }
    ],
    "description":"CustomTlsCertificate CertificateType",
    "default":"CUSTOM_TLS_CERTIFICATE"
}

Nested Schema : connectionSecurityType

STARTTLS connection security.

Default Value: START_TLS_CONNECTION_SECURITY

Match All

STARTTLS connection security.

Show Source

string

Allowed Values: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

Type of security on the mail server connection.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ConnectionSecurityType"
        }
    ],
    "description":"STARTTLS connection security.",
    "default":"START_TLS_CONNECTION_SECURITY"
}

201 Response

Mail server configuration successfully updated.

Root Schema : schema

Type: object

Mail server used to deliver visualizations and reports to users by email.

Show Source

auth(required): object Discriminator: authType

Discriminator: { "propertyName":"authType", "mapping":{ "NO_AUTH":"#/components/schemas/MailServerNoAuth", "USERNAME_PASSWORD_AUTH":"#/components/schemas/MailServerUsernamePasswordAuth", "OAUTH2_AUTH":"#/components/schemas/MailServerOAuth2Auth" } }

Mail server authentication type.
connectionSecurity(required): object Discriminator: connectionSecurityType

Discriminator: { "propertyName":"connectionSecurityType", "mapping":{ "NO_CONNECTION_SECURITY":"#/components/schemas/NoConnectionSecurity", "SSL_TLS_CONNECTION_SECURITY":"#/components/schemas/SslTlsConnectionSecurity", "START_TLS_CONNECTION_SECURITY":"#/components/schemas/StartTlsConnectionSecurity" } }

Connection security options for the mail server connection.
host(required): string

Minimum Length: 1

Host name of the SMTP server you want to use to deliver emails. The SMTP server must be accessible from the public internet.
port(required): integer

Minimum Value: 1

Maximum Value: 65535

Port number on the mail server. Common SMTP ports include: 25 (no security), 465 (SSL TLS), 587 (STARTTLS)
sender(required): object MailSender

Sender of emails

{
    "description":"Mail server used to deliver visualizations and reports to users by email.",
    "type":"object",
    "properties":{
        "host":{
            "type":"string",
            "description":"Host name of the SMTP server you want to use to deliver emails. The SMTP server must be accessible from the public internet.",
            "minLength":1
        },
        "port":{
            "type":"integer",
            "description":"Port number on the mail server. Common SMTP ports include: 25 (no security), 465 (SSL TLS), 587 (STARTTLS)",
            "minimum":1,
            "maximum":65535
        },
        "sender":{
            "$ref":"#/components/schemas/MailSender"
        },
        "auth":{
            "$ref":"#/components/schemas/MailServerAuth"
        },
        "connectionSecurity":{
            "$ref":"#/components/schemas/ConnectionSecurity"
        }
    },
    "required":[
        "host",
        "port",
        "sender",
        "auth",
        "connectionSecurity"
    ]
}

Nested Schema : Discriminator: authType

Type: object

Discriminator: authType

Discriminator Values

NO_AUTH
USERNAME_PASSWORD_AUTH
OAUTH2_AUTH

{
    "description":"Mail server authentication type.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/MailServerNoAuth"
        },
        {
            "$ref":"#/components/schemas/MailServerUsernamePasswordAuth"
        },
        {
            "$ref":"#/components/schemas/MailServerOAuth2Auth"
        }
    ],
    "discriminator":{
        "propertyName":"authType",
        "mapping":{
            "NO_AUTH":"#/components/schemas/MailServerNoAuth",
            "USERNAME_PASSWORD_AUTH":"#/components/schemas/MailServerUsernamePasswordAuth",
            "OAUTH2_AUTH":"#/components/schemas/MailServerOAuth2Auth"
        }
    }
}

Mail server authentication type.

Match One Schema

Show Source

NO_AUTH - object MailServerNoAuth

Mail server doesn???t require authentication.
USERNAME_PASSWORD_AUTH - object MailServerUsernamePasswordAuth

Mail server authentication requires a username and password.
OAUTH2_AUTH - object MailServerOAuth2Auth

Mail server authentication uses OAuth2

{
    "description":"Mail server authentication type.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/MailServerNoAuth"
        },
        {
            "$ref":"#/components/schemas/MailServerUsernamePasswordAuth"
        },
        {
            "$ref":"#/components/schemas/MailServerOAuth2Auth"
        }
    ],
    "discriminator":{
        "propertyName":"authType",
        "mapping":{
            "NO_AUTH":"#/components/schemas/MailServerNoAuth",
            "USERNAME_PASSWORD_AUTH":"#/components/schemas/MailServerUsernamePasswordAuth",
            "OAUTH2_AUTH":"#/components/schemas/MailServerOAuth2Auth"
        }
    }
}

Nested Schema : Discriminator: connectionSecurityType

Type: object

Discriminator: connectionSecurityType

Discriminator Values

NO_CONNECTION_SECURITY
SSL_TLS_CONNECTION_SECURITY
START_TLS_CONNECTION_SECURITY

{
    "description":"Connection security options for the mail server connection.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/NoConnectionSecurity"
        },
        {
            "$ref":"#/components/schemas/SslTlsConnectionSecurity"
        },
        {
            "$ref":"#/components/schemas/StartTlsConnectionSecurity"
        }
    ],
    "discriminator":{
        "propertyName":"connectionSecurityType",
        "mapping":{
            "NO_CONNECTION_SECURITY":"#/components/schemas/NoConnectionSecurity",
            "SSL_TLS_CONNECTION_SECURITY":"#/components/schemas/SslTlsConnectionSecurity",
            "START_TLS_CONNECTION_SECURITY":"#/components/schemas/StartTlsConnectionSecurity"
        }
    }
}

Connection security options for the mail server connection.

Match One Schema

Show Source

NO_CONNECTION_SECURITY - object NoConnectionSecurity

No conection security.
SSL_TLS_CONNECTION_SECURITY - object SslTlsConnectionSecurity

SSL TLS security for the mail server connection.
START_TLS_CONNECTION_SECURITY - object StartTlsConnectionSecurity

STARTTLS security for the mail server connection.

{
    "description":"Connection security options for the mail server connection.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/NoConnectionSecurity"
        },
        {
            "$ref":"#/components/schemas/SslTlsConnectionSecurity"
        },
        {
            "$ref":"#/components/schemas/StartTlsConnectionSecurity"
        }
    ],
    "discriminator":{
        "propertyName":"connectionSecurityType",
        "mapping":{
            "NO_CONNECTION_SECURITY":"#/components/schemas/NoConnectionSecurity",
            "SSL_TLS_CONNECTION_SECURITY":"#/components/schemas/SslTlsConnectionSecurity",
            "START_TLS_CONNECTION_SECURITY":"#/components/schemas/StartTlsConnectionSecurity"
        }
    }
}

Nested Schema : MailSender

Type: object

Sender of emails

Show Source

displayName(required): string

Minimum Length: 1

Name displayed in the 'From' field of emails delivering reports.
emailAddress(required): string

Minimum Length: 1

Email address displayed in the 'From' field of emails delivering reports.

{
    "description":"Sender of emails",
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"Name displayed in the 'From' field of emails delivering reports.",
            "minLength":1
        },
        "emailAddress":{
            "type":"string",
            "description":"Email address displayed in the 'From' field of emails delivering reports.",
            "minLength":1
        }
    },
    "required":[
        "displayName",
        "emailAddress"
    ]
}

Nested Schema : MailServerNoAuth

Type: object

Mail server doesn???t require authentication.

Show Source

authType(required): authType

No authentication type

{
    "description":"Mail server doesn???t require authentication.",
    "type":"object",
    "properties":{
        "authType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/MailServerAuthType"
                }
            ],
            "description":"No authentication type",
            "default":"NO_AUTH"
        }
    },
    "required":[
        "authType"
    ]
}

Nested Schema : MailServerUsernamePasswordAuth

Type: object

Mail server authentication requires a username and password.

Show Source

authType(required): authType

Username and password required for authentication.
password(required): string

Minimum Length: 8

Maximum Length: 255

Password to authenticate access to the mail server.
username(required): string

Minimum Length: 1

Username to authenticate access to the mail server.

{
    "description":"Mail server authentication requires a username and password.",
    "type":"object",
    "properties":{
        "authType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/MailServerAuthType"
                }
            ],
            "description":"Username and password required for authentication.",
            "default":"USERNAME_PASSWORD_AUTH"
        },
        "username":{
            "type":"string",
            "description":"Username to authenticate access to the mail server.",
            "minLength":1
        },
        "password":{
            "type":"string",
            "description":"Password to authenticate access to the mail server.",
            "minLength":8,
            "maxLength":255,
            "writeOnly":true
        }
    },
    "required":[
        "authType",
        "username",
        "password"
    ]
}

Nested Schema : MailServerOAuth2Auth

Type: object

Mail server authentication uses OAuth2

Show Source

authType: authType

OAuth2 AuthType
oAuth2Details(required): object Discriminator: oAuth2Provider

Discriminator: { "propertyName":"oAuth2Provider", "mapping":{ "MS_OAUTH2":"#/components/schemas/MailServerMSOAuth2" } }

Configuration details for a specific OAuth2 provider.

{
    "description":"Mail server authentication uses OAuth2",
    "type":"object",
    "properties":{
        "authType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/AuthType"
                }
            ],
            "description":"OAuth2 AuthType",
            "default":"OAUTH2_AUTH"
        },
        "oAuth2Details":{
            "$ref":"#/components/schemas/MailServerOAuth2Details"
        }
    },
    "required":[
        "oAuth2Details"
    ]
}

Nested Schema : authType

No authentication type

Default Value: NO_AUTH

Match All

No authentication type

Show Source

string

Allowed Values: [ "NO_AUTH", "USERNAME_PASSWORD_AUTH", "OAUTH2_AUTH" ]

Type of authentication the mail server requires.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/MailServerAuthType"
        }
    ],
    "description":"No authentication type",
    "default":"NO_AUTH"
}

Nested Schema : authType

Username and password required for authentication.

Default Value: USERNAME_PASSWORD_AUTH

Match All

Username and password required for authentication.

Show Source

string

Allowed Values: [ "NO_AUTH", "USERNAME_PASSWORD_AUTH", "OAUTH2_AUTH" ]

Type of authentication the mail server requires.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/MailServerAuthType"
        }
    ],
    "description":"Username and password required for authentication.",
    "default":"USERNAME_PASSWORD_AUTH"
}

Nested Schema : authType

OAuth2 AuthType

Default Value: OAUTH2_AUTH

Match All

OAuth2 AuthType

Show Source

string

Allowed Values: [ "OSS_AUTH_OCI_USER_ID", "OCI_RESOURCE_PRINCIPAL" ]

Type of authentication.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AuthType"
        }
    ],
    "description":"OAuth2 AuthType",
    "default":"OAUTH2_AUTH"
}

Nested Schema : Discriminator: oAuth2Provider

Type: object

Discriminator: oAuth2Provider

Discriminator Values

MS_OAUTH2

{
    "description":"Configuration details for a specific OAuth2 provider.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/MailServerMSOAuth2"
        }
    ],
    "discriminator":{
        "propertyName":"oAuth2Provider",
        "mapping":{
            "MS_OAUTH2":"#/components/schemas/MailServerMSOAuth2"
        }
    }
}

Configuration details for a specific OAuth2 provider.

Match One Schema

Show Source

MS_OAUTH2 - object MailServerMSOAuth2

Mail server authentication that uses the Microsoft OAuth2 client credential flow.

{
    "description":"Configuration details for a specific OAuth2 provider.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/MailServerMSOAuth2"
        }
    ],
    "discriminator":{
        "propertyName":"oAuth2Provider",
        "mapping":{
            "MS_OAUTH2":"#/components/schemas/MailServerMSOAuth2"
        }
    }
}

Nested Schema : MailServerMSOAuth2

Type: object

Mail server authentication that uses the Microsoft OAuth2 client credential flow.

Show Source

clientId(required): string

Minimum Length: 1

Maximum Length: 255

OAuth2 client ID required to authenticate access to the mail server.
oAuth2Provider: oAuth2Provider

Specific OAuth2 AuthType
secret(required): string

Minimum Length: 8

Maximum Length: 255

OAuth2 client secret required to authenticate access to the mail server.
tenant(required): string

Minimum Length: 1

Maximum Length: 255

OAuth2 tenant required to authenticate to access the mail server.
username(required): string

Minimum Length: 1

Username required to authenticate to the mail server. Any valid user with access to the mail server.

{
    "description":"Mail server authentication that uses the Microsoft OAuth2 client credential flow.",
    "type":"object",
    "properties":{
        "oAuth2Provider":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/MailServerOAuth2Provider"
                }
            ],
            "description":"Specific OAuth2 AuthType",
            "default":"MS_OAUTH2"
        },
        "username":{
            "type":"string",
            "description":"Username required to authenticate to the mail server. Any valid user with access to the mail server.",
            "minLength":1
        },
        "clientId":{
            "type":"string",
            "description":"OAuth2 client ID required to authenticate access to the mail server.",
            "minLength":1,
            "maxLength":255
        },
        "secret":{
            "type":"string",
            "description":"OAuth2 client secret required to authenticate access to the mail server.",
            "minLength":8,
            "maxLength":255,
            "writeOnly":true
        },
        "tenant":{
            "type":"string",
            "description":"OAuth2 tenant required to authenticate to access the mail server.",
            "minLength":1,
            "maxLength":255
        }
    },
    "required":[
        "username",
        "clientId",
        "secret",
        "tenant"
    ]
}

Nested Schema : oAuth2Provider

Specific OAuth2 AuthType

Default Value: MS_OAUTH2

Match All

Specific OAuth2 AuthType

Show Source

string

Allowed Values: [ "MS_OAUTH2" ]

OAuth2 services provider.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/MailServerOAuth2Provider"
        }
    ],
    "description":"Specific OAuth2 AuthType",
    "default":"MS_OAUTH2"
}

Nested Schema : NoConnectionSecurity

Type: object

No conection security.

Show Source

connectionSecurityType(required): connectionSecurityType

No connection security.

{
    "description":"No conection security.",
    "type":"object",
    "properties":{
        "connectionSecurityType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ConnectionSecurityType"
                }
            ],
            "description":"No connection security.",
            "default":"NO_CONNECTION_SECURITY"
        }
    },
    "required":[
        "connectionSecurityType"
    ]
}

Nested Schema : SslTlsConnectionSecurity

Type: object

SSL TLS security for the mail server connection.

Show Source

connectionSecurityType(required): connectionSecurityType

SSL TLS connection security.
tlsCertificateDetails(required): object Discriminator: certificateType

Discriminator: { "propertyName":"certificateType", "mapping":{ "DEFAULT_TLS_CERTIFICATE":"#/components/schemas/DefaultTlsCertificate", "CUSTOM_TLS_CERTIFICATE":"#/components/schemas/CustomTlsCertificate" } }

Certificate for SSL TLS or START TLS connection security.

{
    "description":"SSL TLS security for the mail server connection.",
    "type":"object",
    "properties":{
        "connectionSecurityType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ConnectionSecurityType"
                }
            ],
            "description":"SSL TLS connection security.",
            "default":"SSL_TLS_CONNECTION_SECURITY"
        },
        "tlsCertificateDetails":{
            "$ref":"#/components/schemas/TlsCertificateDetails"
        }
    },
    "required":[
        "connectionSecurityType",
        "tlsCertificateDetails"
    ]
}

Nested Schema : StartTlsConnectionSecurity

Type: object

STARTTLS security for the mail server connection.

Show Source

connectionSecurityType(required): connectionSecurityType

STARTTLS connection security.
tlsCertificateDetails(required): object Discriminator: certificateType

Discriminator: { "propertyName":"certificateType", "mapping":{ "DEFAULT_TLS_CERTIFICATE":"#/components/schemas/DefaultTlsCertificate", "CUSTOM_TLS_CERTIFICATE":"#/components/schemas/CustomTlsCertificate" } }

Certificate for SSL TLS or START TLS connection security.

{
    "description":"STARTTLS security for the mail server connection.",
    "type":"object",
    "properties":{
        "connectionSecurityType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/ConnectionSecurityType"
                }
            ],
            "description":"STARTTLS connection security.",
            "default":"START_TLS_CONNECTION_SECURITY"
        },
        "tlsCertificateDetails":{
            "$ref":"#/components/schemas/TlsCertificateDetails"
        }
    },
    "required":[
        "connectionSecurityType",
        "tlsCertificateDetails"
    ]
}

Nested Schema : connectionSecurityType

No connection security.

Default Value: NO_CONNECTION_SECURITY

Match All

No connection security.

Show Source

string

Allowed Values: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

Type of security on the mail server connection.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ConnectionSecurityType"
        }
    ],
    "description":"No connection security.",
    "default":"NO_CONNECTION_SECURITY"
}

Nested Schema : connectionSecurityType

SSL TLS connection security.

Default Value: SSL_TLS_CONNECTION_SECURITY

Match All

SSL TLS connection security.

Show Source

string

Allowed Values: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

Type of security on the mail server connection.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ConnectionSecurityType"
        }
    ],
    "description":"SSL TLS connection security.",
    "default":"SSL_TLS_CONNECTION_SECURITY"
}

Nested Schema : Discriminator: certificateType

Type: object

Discriminator: certificateType

Discriminator Values

DEFAULT_TLS_CERTIFICATE
CUSTOM_TLS_CERTIFICATE

{
    "description":"Certificate for SSL TLS or START TLS connection security.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/DefaultTlsCertificate"
        },
        {
            "$ref":"#/components/schemas/CustomTlsCertificate"
        }
    ],
    "discriminator":{
        "propertyName":"certificateType",
        "mapping":{
            "DEFAULT_TLS_CERTIFICATE":"#/components/schemas/DefaultTlsCertificate",
            "CUSTOM_TLS_CERTIFICATE":"#/components/schemas/CustomTlsCertificate"
        }
    }
}

Certificate for SSL TLS or START TLS connection security.

Match One Schema

Show Source

DEFAULT_TLS_CERTIFICATE - object DefaultTlsCertificate

Use the default certificate provided for an SSL-enabled mail server.
CUSTOM_TLS_CERTIFICATE - object CustomTlsCertificate

Use a custom TLS certificate for an SSL-enabled mail server.

{
    "description":"Certificate for SSL TLS or START TLS connection security.",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/DefaultTlsCertificate"
        },
        {
            "$ref":"#/components/schemas/CustomTlsCertificate"
        }
    ],
    "discriminator":{
        "propertyName":"certificateType",
        "mapping":{
            "DEFAULT_TLS_CERTIFICATE":"#/components/schemas/DefaultTlsCertificate",
            "CUSTOM_TLS_CERTIFICATE":"#/components/schemas/CustomTlsCertificate"
        }
    }
}

Nested Schema : DefaultTlsCertificate

Type: object

Use the default certificate provided for an SSL-enabled mail server.

Show Source

certificateType(required): certificateType

Use the mail server???s default TLS certificate.

{
    "description":"Use the default certificate provided for an SSL-enabled mail server.",
    "type":"object",
    "properties":{
        "certificateType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CertificateType"
                }
            ],
            "description":"Use the mail server???s default TLS certificate.",
            "default":"DEFAULT_TLS_CERTIFICATE"
        }
    },
    "required":[
        "certificateType"
    ]
}

Nested Schema : CustomTlsCertificate

Type: object

Use a custom TLS certificate for an SSL-enabled mail server.

Show Source

certificate(required): string

The certificate for an SSL enabled MailServer
certificateType(required): certificateType

CustomTlsCertificate CertificateType

{
    "description":"Use a custom TLS certificate for an SSL-enabled mail server.",
    "type":"object",
    "properties":{
        "certificateType":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CertificateType"
                }
            ],
            "description":"CustomTlsCertificate CertificateType",
            "default":"CUSTOM_TLS_CERTIFICATE"
        },
        "certificate":{
            "type":"string",
            "description":"The certificate for an SSL enabled MailServer",
            "writeOnly":true
        }
    },
    "required":[
        "certificateType",
        "certificate"
    ]
}

Nested Schema : certificateType

Use the mail server???s default TLS certificate.

Default Value: DEFAULT_TLS_CERTIFICATE

Match All

Use the mail server???s default TLS certificate.

Show Source

string

Allowed Values: [ "DEFAULT_TLS_CERTIFICATE", "CUSTOM_TLS_CERTIFICATE" ]

Type of TLS certificate, default or custom.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CertificateType"
        }
    ],
    "description":"Use the mail server???s default TLS certificate.",
    "default":"DEFAULT_TLS_CERTIFICATE"
}

Nested Schema : certificateType

CustomTlsCertificate CertificateType

Default Value: CUSTOM_TLS_CERTIFICATE

Match All

CustomTlsCertificate CertificateType

Show Source

string

Allowed Values: [ "DEFAULT_TLS_CERTIFICATE", "CUSTOM_TLS_CERTIFICATE" ]

Type of TLS certificate, default or custom.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CertificateType"
        }
    ],
    "description":"CustomTlsCertificate CertificateType",
    "default":"CUSTOM_TLS_CERTIFICATE"
}

Nested Schema : connectionSecurityType

STARTTLS connection security.

Default Value: START_TLS_CONNECTION_SECURITY

Match All

STARTTLS connection security.

Show Source

string

Allowed Values: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

Type of security on the mail server connection.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ConnectionSecurityType"
        }
    ],
    "description":"STARTTLS connection security.",
    "default":"START_TLS_CONNECTION_SECURITY"
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Root Schema : Error

Type: object

Show Source

code(required): string

Short error code that defines the error, meant for programmatic parsing.
message(required): string

Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Root Schema : Error

Type: object

Show Source

code(required): string

Short error code that defines the error, meant for programmatic parsing.
message(required): string

Human-readable error string.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

Examples

In this example, you configure a mail server by first creating update_mail_server.json with the required properties. Running this either creates a new mail server configuration (if one doesn't exist) or updates an existing configuration, using the settings in the update_mail_server.json file.

cURL Example

curl -i  \
      --header 'Authorization: Bearer <token>' \
      --header 'Content-Type: application/json' \
      --request PUT 'http://<hostname>/api/20210901/system/mail/server' \
      --data @update_mail_server.json

Examples of Properties JSON

The properties in the JSON file you pass to the mail server API depends on your authentication and certificate requirements. Use the examples below to determine what properties to include in your JSON.

JSON for mail server with authentication and SSLTLS using the default certificate

{
  "host": "mail-server.com",
  "port": 465,
  "sender": {
    "displayName": "John Smith",
    "emailAddress": "john.smith@myorg.com"
  },
  "auth": {
    "authType": "USERNAME_PASSWORD_AUTH",
    "username": "jsmith",
    "password": "mypassword123"
  },
  "connectionSecurity": {
    "connectionSecurityType": "SSL_TLS_CONNECTION_SECURITY",
    "tlsCertificateDetails": {
      "certificateType": "DEFAULT_TLS_CERTIFICATE"
    }
  }
}

JSON for mail server with authentication and STARTTLS using a custom certificate

{
  "host": "mail-server.com",
  "port": 587,
  "sender": {
    "displayName": "John Smith",
    "emailAddress": "john.smith@myorg.com"
  },
  "auth": {
    "authType": "USERNAME_PASSWORD_AUTH",
    "username": "jsmith",
    "password": "mypassword123"
  },
  "connectionSecurity": {
    "connectionSecurityType": "START_TLS_CONNECTION_SECURITY",
    "tlsCertificateDetails": {
      "certificateType": "CUSTOM_TLS_CERTIFICATE",
      "certificate": "-----BEGIN CERTIFICATE-----\nMIIDzD..."
    }
  }
}

Example of Request Body

Not applicable.

Example of Response Body - New mail server created

Status 201:

{
  "host": "mail-server.com",
  "port": 25,
  "sender": {
    "displayName": "John Smith",
    "emailAddress": "john.smith@myorg.com"
  },
  "auth": {
    "authType": "NO_AUTH"
  },
  "connectionSecurity": {
    "connectionSecurityType": "NO_CONNECTION_SECURITY"
  }
}

Example of Response Body - Authentication and SSLTLS using the default certificate

Status 200:

{
  "host": "mail-server.com",
  "port": 465,
  "sender": {
    "displayName": "John Smith",
    "emailAddress": "john.smith@myorg.com"
  },
  "auth": {
    "authType": "USERNAME_PASSWORD_AUTH",
    "username": "jsmith"
  },
  "connectionSecurity": {
    "connectionSecurityType": "SSL_TLS_CONNECTION_SECURITY",
    "tlsCertificateDetails": {
      "certificateType": "DEFAULT_TLS_CERTIFICATE"
    }
  }
}

Example of Response Body - Authentication and STARTTLS using a custom certificate

Status 200:

{
  "host": "mail-server.com",
  "port": 587,
  "sender": {
    "displayName": "John Smith",
    "emailAddress": "john.smith@myorg.com"
  },
  "auth": {
    "authType": "USERNAME_PASSWORD_AUTH",
    "username": "jsmith"
  },
  "connectionSecurity": {
    "connectionSecurityType": "START_TLS_CONNECTION_SECURITY",
    "tlsCertificateDetails": {
      "certificateType": "CUSTOM_TLS_CERTIFICATE"
    }
  }
}