Documentation Powered by ReDoc

docomo business SIGN 脅威検知通知メールAPIリファレンス (1.0.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com License: NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

docomo business SIGN 脅威検知通知メールAPIリファレンス

Authentication

脅威検知通知メール

脅威検知通知メール設定に関する API

脅威検知通知メール設定取得

テナントIDに紐づく、脅威検知通知用のメールアドレスを取得する。

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

Responses

200

The request has succeeded and the tenant is sent in the response.

400

Invalid request parameters.

401

Authentication information is missing or invalid.

404

SSS Tenant not found or resource not found.

500

An unspecified error has occurred.

get/tenants/{tenantId}/security/mail-addresses
https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/security/mail-addresses

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "mailAddresses":
    [
    ],
  • "enabled": false
}

脅威検知通知メール設定削除

テナントIDに紐づけた脅威検知通知用メールアドレス一覧を削除する。

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

Responses

204

No Content

400

Invalid request parameters.

401

Authentication information is missing or invalid.

404

SSS Tenant not found or resource not found.

500

An unspecified error has occurred.

delete/tenants/{tenantId}/security/mail-addresses
https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/security/mail-addresses

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "errorCode": "E40000",
  • "errorMessages":
    [
    ]
}

脅威検知通知メール設定更新

脅威検知通知用メールアドレス登録情報を更新する。

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: 098e5cb2b91c4b63a64e47dfe17a5f76
Request Body schema: application/json
mailAddresses
required
Array of strings <email> (mailAddresses) [ 1 .. 10 ] items

脅威検知通知用登録メールアドレス

enabled
required
boolean (enabled)
Default: false

脅威検知通知ステータス

Responses

201

Created

400

Invalid request parameters.

401

Authentication information is missing or invalid.

500

An unspecified error has occurred.

put/tenants/{tenantId}/security/mail-addresses
https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/security/mail-addresses

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "mailAddresses":
    [
    ],
  • "enabled": false
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "mailAddresses":
    [
    ],
  • "enabled": false
}

脅威検知通知メール設定登録

テナントIDに紐づけて、脅威検知通知用のメールアドレスを登録する。

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000
header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: 098e5cb2b91c4b63a64e47dfe17a5f76
Request Body schema: application/json
mailAddresses
required
Array of strings <email> (mailAddresses) [ 1 .. 10 ] items

脅威検知通知用登録メールアドレス

enabled
required
boolean (enabled)
Default: false

脅威検知通知ステータス

Responses

201

Created

400

Invalid request parameters.

401

Authentication information is missing or invalid.

409

The tenant with the requested tenantId already exists.

500

An unspecified error has occurred.

post/tenants/{tenantId}/security/mail-addresses
https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/security/mail-addresses

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "mailAddresses":
    [
    ],
  • "enabled": false
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "mailAddresses":
    [
    ],
  • "enabled": false
}