IPアドレス
orgリソースを使用して、信頼できるIPアドレス範囲のリストを取得し、信頼できるIPアドレス範囲を追加します。また、信頼できるIPアドレスフィルタリングを有効または無効にすることもできます。
注: サブ組織の信頼済みIP範囲は、親組織の信頼済みIP範囲に依存していません。
GET要求
組織またはサブ組織の信頼済みIPアドレス範囲のリストを要求するには、次のURIを使用します。
/public/core/v3/Orgs/<organization ID>/TrustedIP
GET応答
要求が成功した場合、応答には組織に関する次のような情報が含まれます。
フィールド | タイプ | 説明 |
|---|
orgId | String | 組織ID |
enableIP | Boolean | IPアドレスフィルタリングが有効かどうかを示します。 |
ipRanges | リスト | 組織の信頼済みIPアドレスの範囲。 |
startIP | 文字列 | ipRangesオブジェクトに含まれます。 信頼済みIPアドレスの範囲の最初のIPアドレス。 |
endIP | 文字列 | ipRangesオブジェクトに含まれます。 信頼済みIPアドレスの範囲の最後のIPアドレス。 |
GETの例
組織の信頼済みIP範囲のリストを取得するには、次の例のような要求を送信します。
GET <baseApiUrl>/public/core/v3/Orgs/6MRgiMIfvdRfUuCCCLICcI/TrustedIP
次の例のような応答を受信します。
{
"id": "6MRgiMIfvdRfUuCCCLICcI",
"enableIP": false,
"ipRanges": [
{
"startIP": "10.29.5.1",
"endIP": "10.29.5.2"
}
]
}
PUT要求
組織またはサブ組織の信頼できるIP範囲の値を追加し、信頼できるIP範囲を有効または無効にするには、次のURIを使用してPUT要求を送信します。
/public/core/v3/Orgs/<organization ID>/TrustedIP
注: 組織に信頼済みIPアドレス範囲を追加すると、既存の信頼済みIPアドレス範囲が上書きされます。
以下の情報を含めます。
フィールド | タイプ | 必須 | 説明 |
|---|
enableIP | Boolean | いいえ | IPアドレスフィルタリングを有効にするかどうかを示します。有効にした場合、少なくとも1つのIPアドレス範囲を指定する必要があります。 |
ipRanges | リスト | いいえ | 組織のIPアドレス範囲。 |
startIP | 文字列 | いいえ | ipRangesオブジェクトに含まれます。 信頼済みIPアドレスの範囲の最初のIPアドレス。 |
endIP | 文字列 | いいえ | ipRangesオブジェクトに含まれます。 信頼済みIPアドレスの範囲の最後のIPアドレス。 |
PUT応答
要求が成功した場合、応答には指定した組織の信頼済みIPアドレス情報が含まれます。
PUTの例
組織の信頼済みIPアドレス機能を有効にし、信頼済みIPアドレスの範囲を追加するには、次の例のような要求を送信します。
PUT <baseApiUrl>/public/core/v3/Orgs/6MRgiMIfvdRfUuCCCLICcI/TrustedIP
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: 9KA11tLGqxVcGeul8SQBK3
{
"enableIP": true,
"ipRanges": [
{
"startIP": "10.29.4.5",
"endIP": "10.29.5.2"
}
]
}
次の例のような応答を受信します。
{
"id": "6MRgiMIfvdRfUuCCCLICcI",
"enableIP": true,
"ipRanges": [
{
"startIP": "10.29.4.5",
"endIP": "10.29.5.2"
}
]
}
複数の範囲の信頼済みIPアドレスを追加するには、次の例のような要求を送信します。
PUT <baseApiUrl>/public/core/v3/Orgs/6MRgiMIfvdRfUuCCCLICcI/TrustedIP
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: 9KA11tLGqxVcGeul8SQBK3
{
"enableIP": true,
"ipRanges": [{"startIP": "10.29.4.5", "endIP":"10.29.5.2"}, {"startIP": "10.29.10.1", "endIP":"10.29.10.5"}, {"startIP": "10.29.11.1", "endIP":"10.29.11.5"}]
}
次の例のような応答を受信します。
{
"id": "6MRgiMIfvdRfUuCCCLICcI",
"enableIP": true,
"ipRanges": [
{
"startIP": "10.29.4.5",
"endIP": "10.29.5.2"
},
{
"startIP": "10.29.10.1",
"endIP": "10.29.10.5"
}},
{
"startIP": "10.29.11.1",
"endIP": "10.29.11.5"
}
]
}