Set IP Access Rules#

ユーザーのAPIへのアクセスを制限するために、許可IPリストを登録または更新します。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://access-control.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合 https://access-control.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

POST

/v1.0/access_rule/{user_id}

HTTPステータスコード#

正常時:200

エラー時:400, 401, 403, 404, 500

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定
Description
X-Auth-Token header string 必須 認証のトークン
Content-type header string 必須 MIME仕様で定義されているコンテントの形式
「application/json」を指定します。
user_id path string 必須 ユーザーID
allowed_ip_addresses body array 必須 対象ユーザーの許可IPリスト
IPアドレスは100個まで指定できます。
source_ip body string 必須 対象ユーザーの許可IPアドレス
対象のユーザーにAPIへのアクセスを許可するIPアドレスを以下のように指定します。
- CIDRで指定する場合 : 「xxx.xxx.xxx.xxx/nn」
- 特定のIPアドレス1個を許可する場合 : 「xxx.xxx.xxx.xxx」または「xxx.xxx.xxx.xxx/32」
- グローバルIPアドレス未割り当ての仮想サーバから、APIの実行を許可する場合
  - 東日本リージョン3 : 「JP_EAST3_SNAT_ADDRESS」(固定文字列)
  - 西日本リージョン3 : 「JP_WEST3_SNAT_ADDRESS」(固定文字列)
description body string 任意 「source_ip」の説明

レスポンスボディ(正常系)の説明#

名前 Type Description
user_id string ユーザーID
user_name string ユーザー名
allowed_ip_addresses array 対象ユーザーの許可IPリスト
source_ip string 対象ユーザーの許可IPアドレス
リクエストに指定した内容が表示されます。
description string 「source_ip」の説明
リクエストに指定した内容が表示されます。

リクエスト例#

{
    "allowed_ip_addresses": [
        { "source_ip": "1.2.3.0/24", "description": "company network" },
        { "source_ip": "5.6.7.8", "description": "operation room" }
    ]
}

レスポンス例#

{
    "user_id": "ec688fe82eb94cf399ff845c792e5c10",
    "user_name": "user1",
    "allowed_ip_addresses": [
        { "source_ip": "1.2.3.0/24", "description": "company network" },
        { "source_ip": "5.6.7.8", "description": "operation room" }
    ]
}