第7章 エンドポイントセキュリティー API

7.1. getSecureEndpoint

7.1.1. 説明

指定されたアプリおよびランタイム環境についてのエンドポイントセキュリティーデータを取得します。

7.1.2. エンドポイント

  • URI: /box/srv/1.1/app/endpointsecurity/get
  • メソッド: POST

7.1.3. リクエストボディー

{
  // required
  "appId": "unqiue app identifier",
  // required
  "environment": "dev",
}

7.1.4. レスポンスボディー

7.1.4.1. 成功

{
  "status": "ok",
  "appId": "unqiue app identifier",
  "environment": "dev",
  "default": "https", // can be "https" | "appapikey"
  "updatedBy": "user@example.com",
  "updatedWhen": "2012-12-04 12:00",
  "overrides": {
    "<endpoint name 1>": {
      "security" : "https", // can be "https" | "appapikey",
      "updatedBy": "user@example.com",
      "updatedWhen": "2012-12-04 12:00"
    },
    "<endpoint name 2>": {
      "security" : "https", // can be "https" | "appapikey",
      "updatedBy": "user@example.com",
      "updatedWhen": "2012-12-04 12:00"
    },
    // ...
    "<endpoint name n>": {
      "security" : "https", // can be "https" | "appapikey",
      "updatedBy": "user@example.com",
      "updatedWhen": "2012-12-04 12:00"
    }
  }
}

7.1.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

7.2. setSecureEndpoint

7.2.1. 説明

指定されたアプリおよびランタイム環境についてのエンドポイントセキュリティーデータを設定します。

7.2.2. エンドポイント

  • URI: /box/srv/1.1/app/endpointsecurity/set
  • メソッド: POST

7.2.3. リクエストボディー

{
  // required
  "appId": "unqiue app identifier",
  // required
  "environment": "dev",
  // required
  "default": "https", // can be "https" | "appapikey"
  "overrides": {
    "<endpoint name 1>": {
      "security" : "https" // can be "https" | "appapikey"
    },
    "<endpoint name 2>": {
      "security" : "https" // can be "https" | "appapikey"
    },
    // ...
    "<endpoint name n>": {
      "security" : "https" // can be "https" | "appapikey"
    }
  }
}

7.2.4. レスポンスボディー

7.2.4.1. 成功

{
  "status": "ok"
}

7.2.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

7.3. setSecureEndpointOverride

7.3.1. 説明

アプリおよびランタイム環境の指定されたエンドポイントについてのエンドポイントセキュリティーデータを設定します。これにより、アプリのデフォルトセキュリティー設定が変更されることはありません。

7.3.2. エンドポイント

  • URI: /box/srv/1.1/app/endpointsecurity/setOverride
  • メソッド: POST

7.3.3. リクエストボディー

{
  // required
  "appId": "unqiue app identifier",
  // required
  "environment": "dev",
  // required
  "overrides": {
    "<endpoint name 1>": {
      "security" : "https" // can be "https" | "appapikey"
    },
    "<endpoint name 2>": {
      "security" : "https" // can be "https" | "appapikey"
    },
    // ...
    "<endpoint name n>": {
      "security" : "https" // can be "https" | "appapikey"
    }
  }
}

7.3.4. レスポンスボディー

7.3.4.1. 成功

{
  "status": "ok"
}

7.3.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

7.4. removeSecureEndpointOverride

7.4.1. 説明

アプリの指定されたエンドポイントおよびランタイム環境のエンドポイントセキュリティーのオーバーライドを削除します。これにより、アプリのデフォルトセキュリティー設定が変更されることはありません。

7.4.2. エンドポイント

  • URI: /box/srv/1.1/app/endpointsecurity/removeOverride
  • メソッド: POST

7.4.3. リクエストボディー

{
  // required
  "appId": "unqiue app identifier",
  // required
  "environment": "dev",
  // required
  "endpoint": "<endpoint name>"
}

7.4.4. レスポンスボディー

7.4.4.1. 成功

{
  "status": "ok"
}

7.4.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

7.5. setDefaultSecureEndpoint

7.5.1. 説明

指定されたアプリおよびランタイム環境についてのデフォルトエンドポイントセキュリティーを設定します。

7.5.2. エンドポイント

  • URI: /box/srv/1.1/app/endpointsecurity/setDefault
  • メソッド: POST

7.5.3. リクエストボディー

{
  // required
  "appId": "unqiue app identifier",
  // required
  "environment": "dev",
  // required
  "default": "https" // can be "https" | "appapikey"
}

7.5.4. レスポンスボディー

7.5.4.1. 成功

{
  "status": "ok"
}

7.5.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

7.6. auditLog

7.6.1. 説明

指定されたアプリおよびランタイム環境についてのエンドポイントセキュリティー監査ログデータを取得します。

オプションのフィルターパラメーターは、以下の基準で返される監査ログレコードをフィルターするために指定できます。

  • endpoint: エンドポイントの名前
  • security: https または appapikey を使用できます。
  • updatedBy: userId
  • event: "Set App Security"、"Add Endpoint"、"Remove Endpoint" のいずれか
  • limit: 返すレコードの数

7.6.2. エンドポイント

  • URI: /box/srv/1.1/app/endpointsecurity/auditLog
  • メソッド: POST

7.6.3. リクエストボディー

{
  // required
  "appId": "unqiue app identifier",
  // required
  "environment": "dev",
  "filter": {
    "endpoint": "<endpoint>",
    "security": "<security>",
    "updatedBy": "<updatedBy>",
    "event": "<event>",
    "limit": "<num records>"
  }
}

7.6.4. レスポンスボディー

7.6.4.1. 成功

{
  "list": [
    {
      "appId": "O_6sZAYZN4O3KsJtJ2-ssvAf",
      "endpoint": "getDemo",
      "environment": "dev",
      "event": "Add Endpoint",
      "security": "https",
      "updatedBy": "training@example.com",
      "updatedWhen": "Thu Dec 13 12:01:33 UTC 2012",
      "updatedWhenMillis": 1355400093157
    },
    {
      "appId": "O_6sZAYZN4O3KsJtJ2-ssvAf",
      "endpoint": "",
      "environment": "dev",
      "event": "Set App Security",
      "security": "appapikey",
      "updatedBy": "training@example.com",
      "updatedWhen": "Thu Dec 13 11:57:24 UTC 2012",
      "updatedWhenMillis": 1355399844528
    }
  ],
  "status": "ok"
}

7.6.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}