Oracle Analytics CloudのためのREST API

機械翻訳について

メール・サーバーの構成

put

/api/20210901/system/mail/server

レポートおよびビジュアライゼーションを配信する電子メール・サーバーを構成します。

リクエスト

この操作のリクエスト・パラメータはありません。

サポートされているメディア・タイプ

application/json

ルート・スキーマ: schema

Type: object

電子メールによるユーザーへのビジュアライゼーションおよびレポートの配信に使用されるメール・サーバー。

ソースを表示

auth(required): object Discriminator: authType

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

メール・サーバー認証タイプ。
connectionSecurity(required): object Discriminator: connectionSecurityType

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

メール・サーバー接続の接続セキュリティ・オプション。
host(required): string

最小長: 1

電子メールの配信に使用するSMTPサーバーのホスト名。 SMTPサーバーは、パブリック・インターネットからアクセスできる必要があります。
port(required): integer

最小値: 1

最大値: 65535

メール・サーバーのポート番号。一般的なSMTPポートには次のものがあります: 25 (no security), 465 (SSL TLS), 587 (STARTTLS)
sender(required): object MailSender

電子メールの送信者

{
    "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"
    ]
}

ネストされたスキーマ : 識別子 : authType

Type: object

識別子: 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"
        }
    }
}

メール・サーバー認証タイプ。

1つのスキーマに一致

ソースを表示

NO_AUTH - object MailServerNoAuth

メール・サーバーは認証を必要としません。
USERNAME_PASSWORD_AUTH - object MailServerUsernamePasswordAuth

メール・サーバー認証にはユーザー名とパスワードが必要です。
OAUTH2_AUTH - object MailServerOAuth2Auth

メール・サーバー認証では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"
        }
    }
}

ネストされたスキーマ : 識別子 : connectionSecurityType

Type: object

識別子: connectionSecurityType

弁別子の値

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"
        }
    }
}

メール・サーバー接続の接続セキュリティ・オプション。

1つのスキーマに一致

ソースを表示

NO_CONNECTION_SECURITY - object NoConnectionSecurity

接続セキュリティなし。
SSL_TLS_CONNECTION_SECURITY - object SslTlsConnectionSecurity

メール・サーバー接続のSSL TLSセキュリティ。
START_TLS_CONNECTION_SECURITY - object StartTlsConnectionSecurity

メール・サーバー接続のSTARTTLSセキュリティ。

{
    "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"
        }
    }
}

ネストされたスキーマ : MailSender

Type: object

電子メールの送信者

ソースを表示

displayName(必須): string

最小長: 1

レポートを配信するEメールの「自」フィールドに表示される名前。
emailAddress(required): string

最小長: 1

レポートを配信するEメールの「送信元」フィールドに表示されるEメール・アドレス。

{
    "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"
    ]
}

ネストされたスキーマ : MailServerNoAuth

Type: object

メール・サーバーは認証を必要としません。

ソースを表示

authType(required): authType

認証タイプがありません

{
    "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"
    ]
}

ネストされたスキーマ : MailServerUsernamePasswordAuth

Type: object

メール・サーバー認証にはユーザー名とパスワードが必要です。

ソースを表示

authType(required): authType

認証に必要なユーザー名とパスワード。
password(必須): string

最小長: 8

最大長: 255

メール・サーバーへのアクセスを認証するためのパスワード。
username(必須): string

最小長: 1

メール・サーバーへのアクセスを認証するユーザー名。

{
    "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"
    ]
}

ネストされたスキーマ : MailServerOAuth2Auth

Type: object

メール・サーバー認証ではOAuth2を使用

ソースを表示

authType: authType

OAuth2 AuthType
oAuth2Details(required): object Discriminator: oAuth2Provider

識別子: { "propertyName":"oAuth2Provider", "mapping":{ "MS_OAUTH2":"#/components/schemas/MailServerMSOAuth2" } }

特定のOAuth2プロバイダの構成の詳細。

{
    "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"
    ]
}

ネストされたスキーマ : authType

認証タイプがありません

デフォルト値: NO_AUTH

すべてに一致

認証タイプがありません

ソースを表示

string

許容値: [ "NO_AUTH", "USERNAME_PASSWORD_AUTH", "OAUTH2_AUTH" ]

メール・サーバーが必要とする認証のタイプ。

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

ネストされたスキーマ : authType

認証に必要なユーザー名とパスワード。

デフォルト値: USERNAME_PASSWORD_AUTH

すべてに一致

認証に必要なユーザー名とパスワード。

ソースを表示

string

許容値: [ "NO_AUTH", "USERNAME_PASSWORD_AUTH", "OAUTH2_AUTH" ]

メール・サーバーが必要とする認証のタイプ。

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

ネストされたスキーマ : authType

OAuth2 AuthType

デフォルト値: OAUTH2_AUTH

すべてに一致

OAuth2 AuthType

ソースを表示

string

許容値: [ "OSS_AUTH_OCI_USER_ID", "OCI_RESOURCE_PRINCIPAL" ]

認証のタイプ。

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

ネストされたスキーマ : 識別子 : oAuth2Provider

Type: object

識別子: oAuth2Provider

弁別子の値

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"
        }
    }
}

特定のOAuth2プロバイダの構成の詳細。

1つのスキーマに一致

ソースを表示

MS_OAUTH2 - object MailServerMSOAuth2

Microsoft 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"
        }
    }
}

ネストされたスキーマ : MailServerMSOAuth2

Type: object

Microsoft OAuth2クライアント資格証明フローを使用するメール・サーバー認証。

ソースを表示

clientId(required): string

最小長: 1

最大長: 255

メール・サーバーへのアクセスの認証に必要なOAuth2クライアントID。
oAuth2Provider: oAuth2Provider

特定のOAuth2 AuthType
secret(required): string

最小長: 8

最大長: 255

メール・サーバーへのアクセスの認証に必要なOAuth2クライアント・シークレット。
tenant(required): string

最小長: 1

最大長: 255

メール・サーバーへのアクセスの認証に必要なOAuth2テナント。
username(必須): string

最小長: 1

メール・サーバーへの認証に必要なユーザー名。メール・サーバーにアクセスできる任意の有効なユーザー。

{
    "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"
    ]
}

ネストされたスキーマ : oAuth2Provider

特定のOAuth2 AuthType

デフォルト値: MS_OAUTH2

すべてに一致

特定のOAuth2 AuthType

ソースを表示

string

許容値: [ "MS_OAUTH2" ]

OAuth2サービス・プロバイダ。

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

ネストされたスキーマ : NoConnectionSecurity

Type: object

接続セキュリティなし。

ソースを表示

connectionSecurityType(required): connectionSecurityType

接続セキュリティがありません。

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

ネストされたスキーマ : SslTlsConnectionSecurity

Type: object

メール・サーバー接続のSSL TLSセキュリティ。

ソースを表示

connectionSecurityType(required): connectionSecurityType

SSL TLS接続セキュリティ。
tlsCertificateDetails(required): object Discriminator: certificateType

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

SSL TLSまたはSTART TLS接続セキュリティの証明書。

{
    "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"
    ]
}

ネストされたスキーマ : StartTlsConnectionSecurity

Type: object

メール・サーバー接続のSTARTTLSセキュリティ。

ソースを表示

connectionSecurityType(required): connectionSecurityType

STARTTLS接続セキュリティ。
tlsCertificateDetails(required): object Discriminator: certificateType

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

SSL TLSまたはSTART TLS接続セキュリティの証明書。

{
    "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"
    ]
}

ネストされたスキーマ : connectionSecurityType

接続セキュリティがありません。

デフォルト値: NO_CONNECTION_SECURITY

すべてに一致

接続セキュリティがありません。

ソースを表示

string

許容値: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

メール・サーバー接続のセキュリティのタイプ。

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

ネストされたスキーマ : connectionSecurityType

SSL TLS接続セキュリティ。

デフォルト値: SSL_TLS_CONNECTION_SECURITY

すべてに一致

SSL TLS接続セキュリティ。

ソースを表示

string

許容値: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

メール・サーバー接続のセキュリティのタイプ。

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

ネストされたスキーマ : 識別子 : certificateType

Type: object

識別子: certificateType

弁別子の値

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"
        }
    }
}

SSL TLSまたはSTART TLS接続セキュリティの証明書。

1つのスキーマに一致

ソースを表示

DEFAULT_TLS_CERTIFICATE - object DefaultTlsCertificate

SSL対応のメール・サーバー用に用意されているデフォルトの証明書を使用します。
CUSTOM_TLS_CERTIFICATE - object CustomTlsCertificate

SSL対応メール・サーバーには、カスタムTLS証明書を使用します。

{
    "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"
        }
    }
}

ネストされたスキーマ : DefaultTlsCertificate

Type: object

SSL対応のメール・サーバー用に用意されているデフォルトの証明書を使用します。

ソースを表示

certificateType(required): certificateType

メール・サーバー???sのデフォルトTLS証明書を使用します。

{
    "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"
    ]
}

ネストされたスキーマ : CustomTlsCertificate

Type: object

SSL対応メール・サーバーには、カスタムTLS証明書を使用します。

ソースを表示

certificate(required): string

SSL対応の証明書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"
    ]
}

ネストされたスキーマ : certificateType

メール・サーバー???sのデフォルトTLS証明書を使用します。

デフォルト値: DEFAULT_TLS_CERTIFICATE

すべてに一致

メール・サーバー???sのデフォルトTLS証明書を使用します。

ソースを表示

string

許容値: [ "DEFAULT_TLS_CERTIFICATE", "CUSTOM_TLS_CERTIFICATE" ]

TLS証明書のタイプ(デフォルトまたはカスタム)。

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

ネストされたスキーマ : certificateType

CustomTlsCertificate CertificateType

デフォルト値: CUSTOM_TLS_CERTIFICATE

すべてに一致

CustomTlsCertificate CertificateType

ソースを表示

string

許容値: [ "DEFAULT_TLS_CERTIFICATE", "CUSTOM_TLS_CERTIFICATE" ]

TLS証明書のタイプ(デフォルトまたはカスタム)。

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

ネストされたスキーマ : connectionSecurityType

STARTTLS接続セキュリティ。

デフォルト値: START_TLS_CONNECTION_SECURITY

すべてに一致

STARTTLS接続セキュリティ。

ソースを表示

string

許容値: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

メール・サーバー接続のセキュリティのタイプ。

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

先頭に戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

メール・サーバーは正常に構成されました。

ルート・スキーマ: schema

Type: object

電子メールによるユーザーへのビジュアライゼーションおよびレポートの配信に使用されるメール・サーバー。

ソースを表示

auth(required): object Discriminator: authType

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

メール・サーバー認証タイプ。
connectionSecurity(required): object Discriminator: connectionSecurityType

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

メール・サーバー接続の接続セキュリティ・オプション。
host(required): string

最小長: 1

電子メールの配信に使用するSMTPサーバーのホスト名。 SMTPサーバーは、パブリック・インターネットからアクセスできる必要があります。
port(required): integer

最小値: 1

最大値: 65535

メール・サーバーのポート番号。一般的なSMTPポートには次のものがあります: 25 (no security), 465 (SSL TLS), 587 (STARTTLS)
sender(required): object MailSender

電子メールの送信者

{
    "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"
    ]
}

ネストされたスキーマ : 識別子 : authType

Type: object

識別子: authType

弁別子の値

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"
        }
    }
}

メール・サーバー認証タイプ。

1つのスキーマに一致

ソースを表示

NO_AUTH - object MailServerNoAuth

メール・サーバーは認証を必要としません。
USERNAME_PASSWORD_AUTH - object MailServerUsernamePasswordAuth

メール・サーバー認証にはユーザー名とパスワードが必要です。
OAUTH2_AUTH - object MailServerOAuth2Auth

メール・サーバー認証では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"
        }
    }
}

ネストされたスキーマ : 識別子 : connectionSecurityType

Type: object

識別子: connectionSecurityType

弁別子の値

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"
        }
    }
}

メール・サーバー接続の接続セキュリティ・オプション。

1つのスキーマに一致

ソースを表示

NO_CONNECTION_SECURITY - object NoConnectionSecurity

接続セキュリティなし。
SSL_TLS_CONNECTION_SECURITY - object SslTlsConnectionSecurity

メール・サーバー接続のSSL TLSセキュリティ。
START_TLS_CONNECTION_SECURITY - object StartTlsConnectionSecurity

メール・サーバー接続のSTARTTLSセキュリティ。

{
    "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"
        }
    }
}

ネストされたスキーマ : MailSender

Type: object

電子メールの送信者

ソースを表示

displayName(必須): string

最小長: 1

レポートを配信するEメールの「自」フィールドに表示される名前。
emailAddress(required): string

最小長: 1

レポートを配信するEメールの「送信元」フィールドに表示されるEメール・アドレス。

{
    "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"
    ]
}

ネストされたスキーマ : MailServerNoAuth

Type: object

メール・サーバーは認証を必要としません。

ソースを表示

authType(required): authType

認証タイプがありません

{
    "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"
    ]
}

ネストされたスキーマ : MailServerUsernamePasswordAuth

Type: object

メール・サーバー認証にはユーザー名とパスワードが必要です。

ソースを表示

authType(required): authType

認証に必要なユーザー名とパスワード。
password(必須): string

最小長: 8

最大長: 255

メール・サーバーへのアクセスを認証するためのパスワード。
username(必須): string

最小長: 1

メール・サーバーへのアクセスを認証するユーザー名。

{
    "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"
    ]
}

ネストされたスキーマ : MailServerOAuth2Auth

Type: object

メール・サーバー認証ではOAuth2を使用

ソースを表示

authType: authType

OAuth2 AuthType
oAuth2Details(required): object Discriminator: oAuth2Provider

識別子: { "propertyName":"oAuth2Provider", "mapping":{ "MS_OAUTH2":"#/components/schemas/MailServerMSOAuth2" } }

特定のOAuth2プロバイダの構成の詳細。

{
    "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"
    ]
}

ネストされたスキーマ : authType

認証タイプがありません

デフォルト値: NO_AUTH

すべてに一致

認証タイプがありません

ソースを表示

string

許容値: [ "NO_AUTH", "USERNAME_PASSWORD_AUTH", "OAUTH2_AUTH" ]

メール・サーバーが必要とする認証のタイプ。

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

ネストされたスキーマ : authType

認証に必要なユーザー名とパスワード。

デフォルト値: USERNAME_PASSWORD_AUTH

すべてに一致

認証に必要なユーザー名とパスワード。

ソースを表示

string

許容値: [ "NO_AUTH", "USERNAME_PASSWORD_AUTH", "OAUTH2_AUTH" ]

メール・サーバーが必要とする認証のタイプ。

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

ネストされたスキーマ : authType

OAuth2 AuthType

デフォルト値: OAUTH2_AUTH

すべてに一致

OAuth2 AuthType

ソースを表示

string

許容値: [ "OSS_AUTH_OCI_USER_ID", "OCI_RESOURCE_PRINCIPAL" ]

認証のタイプ。

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

ネストされたスキーマ : 識別子 : oAuth2Provider

Type: object

識別子: oAuth2Provider

弁別子の値

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"
        }
    }
}

特定のOAuth2プロバイダの構成の詳細。

1つのスキーマに一致

ソースを表示

MS_OAUTH2 - object MailServerMSOAuth2

Microsoft 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"
        }
    }
}

ネストされたスキーマ : MailServerMSOAuth2

Type: object

Microsoft OAuth2クライアント資格証明フローを使用するメール・サーバー認証。

ソースを表示

clientId(required): string

最小長: 1

最大長: 255

メール・サーバーへのアクセスの認証に必要なOAuth2クライアントID。
oAuth2Provider: oAuth2Provider

特定のOAuth2 AuthType
secret(required): string

最小長: 8

最大長: 255

メール・サーバーへのアクセスの認証に必要なOAuth2クライアント・シークレット。
tenant(required): string

最小長: 1

最大長: 255

メール・サーバーへのアクセスの認証に必要なOAuth2テナント。
username(必須): string

最小長: 1

メール・サーバーへの認証に必要なユーザー名。メール・サーバーにアクセスできる任意の有効なユーザー。

{
    "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"
    ]
}

ネストされたスキーマ : oAuth2Provider

特定のOAuth2 AuthType

デフォルト値: MS_OAUTH2

すべてに一致

特定のOAuth2 AuthType

ソースを表示

string

許容値: [ "MS_OAUTH2" ]

OAuth2サービス・プロバイダ。

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

ネストされたスキーマ : NoConnectionSecurity

Type: object

接続セキュリティなし。

ソースを表示

connectionSecurityType(required): connectionSecurityType

接続セキュリティがありません。

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

ネストされたスキーマ : SslTlsConnectionSecurity

Type: object

メール・サーバー接続のSSL TLSセキュリティ。

ソースを表示

connectionSecurityType(required): connectionSecurityType

SSL TLS接続セキュリティ。
tlsCertificateDetails(required): object Discriminator: certificateType

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

SSL TLSまたはSTART TLS接続セキュリティの証明書。

{
    "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"
    ]
}

ネストされたスキーマ : StartTlsConnectionSecurity

Type: object

メール・サーバー接続のSTARTTLSセキュリティ。

ソースを表示

connectionSecurityType(required): connectionSecurityType

STARTTLS接続セキュリティ。
tlsCertificateDetails(required): object Discriminator: certificateType

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

SSL TLSまたはSTART TLS接続セキュリティの証明書。

{
    "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"
    ]
}

ネストされたスキーマ : connectionSecurityType

接続セキュリティがありません。

デフォルト値: NO_CONNECTION_SECURITY

すべてに一致

接続セキュリティがありません。

ソースを表示

string

許容値: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

メール・サーバー接続のセキュリティのタイプ。

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

ネストされたスキーマ : connectionSecurityType

SSL TLS接続セキュリティ。

デフォルト値: SSL_TLS_CONNECTION_SECURITY

すべてに一致

SSL TLS接続セキュリティ。

ソースを表示

string

許容値: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

メール・サーバー接続のセキュリティのタイプ。

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

ネストされたスキーマ : 識別子 : certificateType

Type: object

識別子: certificateType

弁別子の値

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"
        }
    }
}

SSL TLSまたはSTART TLS接続セキュリティの証明書。

1つのスキーマに一致

ソースを表示

DEFAULT_TLS_CERTIFICATE - object DefaultTlsCertificate

SSL対応のメール・サーバー用に用意されているデフォルトの証明書を使用します。
CUSTOM_TLS_CERTIFICATE - object CustomTlsCertificate

SSL対応メール・サーバーには、カスタムTLS証明書を使用します。

{
    "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"
        }
    }
}

ネストされたスキーマ : DefaultTlsCertificate

Type: object

SSL対応のメール・サーバー用に用意されているデフォルトの証明書を使用します。

ソースを表示

certificateType(required): certificateType

メール・サーバー???sのデフォルトTLS証明書を使用します。

{
    "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"
    ]
}

ネストされたスキーマ : CustomTlsCertificate

Type: object

SSL対応メール・サーバーには、カスタムTLS証明書を使用します。

ソースを表示

certificate(required): string

SSL対応の証明書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"
    ]
}

ネストされたスキーマ : certificateType

メール・サーバー???sのデフォルトTLS証明書を使用します。

デフォルト値: DEFAULT_TLS_CERTIFICATE

すべてに一致

メール・サーバー???sのデフォルトTLS証明書を使用します。

ソースを表示

string

許容値: [ "DEFAULT_TLS_CERTIFICATE", "CUSTOM_TLS_CERTIFICATE" ]

TLS証明書のタイプ(デフォルトまたはカスタム)。

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

ネストされたスキーマ : certificateType

CustomTlsCertificate CertificateType

デフォルト値: CUSTOM_TLS_CERTIFICATE

すべてに一致

CustomTlsCertificate CertificateType

ソースを表示

string

許容値: [ "DEFAULT_TLS_CERTIFICATE", "CUSTOM_TLS_CERTIFICATE" ]

TLS証明書のタイプ(デフォルトまたはカスタム)。

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

ネストされたスキーマ : connectionSecurityType

STARTTLS接続セキュリティ。

デフォルト値: START_TLS_CONNECTION_SECURITY

すべてに一致

STARTTLS接続セキュリティ。

ソースを表示

string

許容値: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

メール・サーバー接続のセキュリティのタイプ。

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

201レスポンス

メール・サーバー構成は正常に更新されました。

ルート・スキーマ: schema

Type: object

電子メールによるユーザーへのビジュアライゼーションおよびレポートの配信に使用されるメール・サーバー。

ソースを表示

auth(required): object Discriminator: authType

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

メール・サーバー認証タイプ。
connectionSecurity(required): object Discriminator: connectionSecurityType

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

メール・サーバー接続の接続セキュリティ・オプション。
host(required): string

最小長: 1

電子メールの配信に使用するSMTPサーバーのホスト名。 SMTPサーバーは、パブリック・インターネットからアクセスできる必要があります。
port(required): integer

最小値: 1

最大値: 65535

メール・サーバーのポート番号。一般的なSMTPポートには次のものがあります: 25 (no security), 465 (SSL TLS), 587 (STARTTLS)
sender(required): object MailSender

電子メールの送信者

{
    "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"
    ]
}

ネストされたスキーマ : 識別子 : authType

Type: object

識別子: authType

弁別子の値

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"
        }
    }
}

メール・サーバー認証タイプ。

1つのスキーマに一致

ソースを表示

NO_AUTH - object MailServerNoAuth

メール・サーバーは認証を必要としません。
USERNAME_PASSWORD_AUTH - object MailServerUsernamePasswordAuth

メール・サーバー認証にはユーザー名とパスワードが必要です。
OAUTH2_AUTH - object MailServerOAuth2Auth

メール・サーバー認証では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"
        }
    }
}

ネストされたスキーマ : 識別子 : connectionSecurityType

Type: object

識別子: connectionSecurityType

弁別子の値

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"
        }
    }
}

メール・サーバー接続の接続セキュリティ・オプション。

1つのスキーマに一致

ソースを表示

NO_CONNECTION_SECURITY - object NoConnectionSecurity

接続セキュリティなし。
SSL_TLS_CONNECTION_SECURITY - object SslTlsConnectionSecurity

メール・サーバー接続のSSL TLSセキュリティ。
START_TLS_CONNECTION_SECURITY - object StartTlsConnectionSecurity

メール・サーバー接続のSTARTTLSセキュリティ。

{
    "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"
        }
    }
}

ネストされたスキーマ : MailSender

Type: object

電子メールの送信者

ソースを表示

displayName(必須): string

最小長: 1

レポートを配信するEメールの「自」フィールドに表示される名前。
emailAddress(required): string

最小長: 1

レポートを配信するEメールの「送信元」フィールドに表示されるEメール・アドレス。

{
    "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"
    ]
}

ネストされたスキーマ : MailServerNoAuth

Type: object

メール・サーバーは認証を必要としません。

ソースを表示

authType(required): authType

認証タイプがありません

{
    "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"
    ]
}

ネストされたスキーマ : MailServerUsernamePasswordAuth

Type: object

メール・サーバー認証にはユーザー名とパスワードが必要です。

ソースを表示

authType(required): authType

認証に必要なユーザー名とパスワード。
password(必須): string

最小長: 8

最大長: 255

メール・サーバーへのアクセスを認証するためのパスワード。
username(必須): string

最小長: 1

メール・サーバーへのアクセスを認証するユーザー名。

{
    "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"
    ]
}

ネストされたスキーマ : MailServerOAuth2Auth

Type: object

メール・サーバー認証ではOAuth2を使用

ソースを表示

authType: authType

OAuth2 AuthType
oAuth2Details(required): object Discriminator: oAuth2Provider

識別子: { "propertyName":"oAuth2Provider", "mapping":{ "MS_OAUTH2":"#/components/schemas/MailServerMSOAuth2" } }

特定のOAuth2プロバイダの構成の詳細。

{
    "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"
    ]
}

ネストされたスキーマ : authType

認証タイプがありません

デフォルト値: NO_AUTH

すべてに一致

認証タイプがありません

ソースを表示

string

許容値: [ "NO_AUTH", "USERNAME_PASSWORD_AUTH", "OAUTH2_AUTH" ]

メール・サーバーが必要とする認証のタイプ。

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

ネストされたスキーマ : authType

認証に必要なユーザー名とパスワード。

デフォルト値: USERNAME_PASSWORD_AUTH

すべてに一致

認証に必要なユーザー名とパスワード。

ソースを表示

string

許容値: [ "NO_AUTH", "USERNAME_PASSWORD_AUTH", "OAUTH2_AUTH" ]

メール・サーバーが必要とする認証のタイプ。

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

ネストされたスキーマ : authType

OAuth2 AuthType

デフォルト値: OAUTH2_AUTH

すべてに一致

OAuth2 AuthType

ソースを表示

string

許容値: [ "OSS_AUTH_OCI_USER_ID", "OCI_RESOURCE_PRINCIPAL" ]

認証のタイプ。

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

ネストされたスキーマ : 識別子 : oAuth2Provider

Type: object

識別子: oAuth2Provider

弁別子の値

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"
        }
    }
}

特定のOAuth2プロバイダの構成の詳細。

1つのスキーマに一致

ソースを表示

MS_OAUTH2 - object MailServerMSOAuth2

Microsoft 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"
        }
    }
}

ネストされたスキーマ : MailServerMSOAuth2

Type: object

Microsoft OAuth2クライアント資格証明フローを使用するメール・サーバー認証。

ソースを表示

clientId(required): string

最小長: 1

最大長: 255

メール・サーバーへのアクセスの認証に必要なOAuth2クライアントID。
oAuth2Provider: oAuth2Provider

特定のOAuth2 AuthType
secret(required): string

最小長: 8

最大長: 255

メール・サーバーへのアクセスの認証に必要なOAuth2クライアント・シークレット。
tenant(required): string

最小長: 1

最大長: 255

メール・サーバーへのアクセスの認証に必要なOAuth2テナント。
username(必須): string

最小長: 1

メール・サーバーへの認証に必要なユーザー名。メール・サーバーにアクセスできる任意の有効なユーザー。

{
    "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"
    ]
}

ネストされたスキーマ : oAuth2Provider

特定のOAuth2 AuthType

デフォルト値: MS_OAUTH2

すべてに一致

特定のOAuth2 AuthType

ソースを表示

string

許容値: [ "MS_OAUTH2" ]

OAuth2サービス・プロバイダ。

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

ネストされたスキーマ : NoConnectionSecurity

Type: object

接続セキュリティなし。

ソースを表示

connectionSecurityType(required): connectionSecurityType

接続セキュリティがありません。

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

ネストされたスキーマ : SslTlsConnectionSecurity

Type: object

メール・サーバー接続のSSL TLSセキュリティ。

ソースを表示

connectionSecurityType(required): connectionSecurityType

SSL TLS接続セキュリティ。
tlsCertificateDetails(required): object Discriminator: certificateType

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

SSL TLSまたはSTART TLS接続セキュリティの証明書。

{
    "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"
    ]
}

ネストされたスキーマ : StartTlsConnectionSecurity

Type: object

メール・サーバー接続のSTARTTLSセキュリティ。

ソースを表示

connectionSecurityType(required): connectionSecurityType

STARTTLS接続セキュリティ。
tlsCertificateDetails(required): object Discriminator: certificateType

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

SSL TLSまたはSTART TLS接続セキュリティの証明書。

{
    "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"
    ]
}

ネストされたスキーマ : connectionSecurityType

接続セキュリティがありません。

デフォルト値: NO_CONNECTION_SECURITY

すべてに一致

接続セキュリティがありません。

ソースを表示

string

許容値: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

メール・サーバー接続のセキュリティのタイプ。

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

ネストされたスキーマ : connectionSecurityType

SSL TLS接続セキュリティ。

デフォルト値: SSL_TLS_CONNECTION_SECURITY

すべてに一致

SSL TLS接続セキュリティ。

ソースを表示

string

許容値: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

メール・サーバー接続のセキュリティのタイプ。

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

ネストされたスキーマ : 識別子 : certificateType

Type: object

識別子: certificateType

弁別子の値

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"
        }
    }
}

SSL TLSまたはSTART TLS接続セキュリティの証明書。

1つのスキーマに一致

ソースを表示

DEFAULT_TLS_CERTIFICATE - object DefaultTlsCertificate

SSL対応のメール・サーバー用に用意されているデフォルトの証明書を使用します。
CUSTOM_TLS_CERTIFICATE - object CustomTlsCertificate

SSL対応メール・サーバーには、カスタムTLS証明書を使用します。

{
    "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"
        }
    }
}

ネストされたスキーマ : DefaultTlsCertificate

Type: object

SSL対応のメール・サーバー用に用意されているデフォルトの証明書を使用します。

ソースを表示

certificateType(required): certificateType

メール・サーバー???sのデフォルトTLS証明書を使用します。

{
    "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"
    ]
}

ネストされたスキーマ : CustomTlsCertificate

Type: object

SSL対応メール・サーバーには、カスタムTLS証明書を使用します。

ソースを表示

certificate(required): string

SSL対応の証明書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"
    ]
}

ネストされたスキーマ : certificateType

メール・サーバー???sのデフォルトTLS証明書を使用します。

デフォルト値: DEFAULT_TLS_CERTIFICATE

すべてに一致

メール・サーバー???sのデフォルトTLS証明書を使用します。

ソースを表示

string

許容値: [ "DEFAULT_TLS_CERTIFICATE", "CUSTOM_TLS_CERTIFICATE" ]

TLS証明書のタイプ(デフォルトまたはカスタム)。

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

ネストされたスキーマ : certificateType

CustomTlsCertificate CertificateType

デフォルト値: CUSTOM_TLS_CERTIFICATE

すべてに一致

CustomTlsCertificate CertificateType

ソースを表示

string

許容値: [ "DEFAULT_TLS_CERTIFICATE", "CUSTOM_TLS_CERTIFICATE" ]

TLS証明書のタイプ(デフォルトまたはカスタム)。

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

ネストされたスキーマ : connectionSecurityType

STARTTLS接続セキュリティ。

デフォルト値: START_TLS_CONNECTION_SECURITY

すべてに一致

STARTTLS接続セキュリティ。

ソースを表示

string

許容値: [ "NO_CONNECTION_SECURITY", "SSL_TLS_CONNECTION_SECURITY", "START_TLS_CONNECTION_SECURITY" ]

メール・サーバー接続のセキュリティのタイプ。

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

400レスポンス

不正なリクエスト(無効な問合せパラメータ、不正なヘッダーなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラム解析のためのエラーを定義する短いエラー・コード。
message(必須): 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レスポンス

未承認(資格証明がないか期限切れなど)。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラム解析のためのエラーを定義する短いエラー・コード。
message(必須): 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"
    ]
}

先頭に戻る

例

この例では、まず必要なプロパティでupdate_mail_server.jsonを作成して、メール・サーバーを構成します。これを実行すると、新しいメール・サーバー構成(存在しない場合)が作成されるか、update_mail_server.jsonファイルの設定を使用して既存の構成が更新されます。

cURLの例

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

プロパティJSONの例

メール・サーバーAPIに渡すJSONファイルのプロパティは、認証および証明書の要件によって異なります。次の例を使用して、JSONに含めるプロパティを決定します。

デフォルトの証明書を使用した認証およびSSLTLSを使用するメール・サーバーのJSON

{
  "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"
    }
  }
}

認証を使用するメール・サーバーおよびカスタム証明書を使用するSTARTTLS用のJSON

{
  "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..."
    }
  }
}

OAuth2認証を使用したメール・サーバーのJSON

{
    "host": "mail-server.com",
    "port": 1,
    "sender": {
        "displayName": "John Smith",
        "emailAddress": "john.smith@myorg.com"
    },
    "auth": {
        "authType": "OAUTH2_AUTH",
        "oAuth2Details": {
            "username": "jsmith",
            "oAuth2Provider": "MS_OAUTH2",
            "secret": "mySecretValue",
            "clientId": "oauthClientID",
            "tenant": "myTenantID"
        }
    },
    "connectionSecurity": {
        "connectionSecurityType": "NO_CONNECTION_SECURITY"
    }
}

リクエスト本文の例

Not applicable.

レスポンス本文の例 - 新しいメール・サーバーが作成されました

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"
  }
}

レスポンス本文の例 - デフォルトの証明書を使用した認証およびSSLTLS

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"
    }
  }
}

レスポンス本文の例 - カスタム証明書を使用した認証およびSTARTTLS

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"
    }
  }
}

先頭に戻る