オーガニゼーションの情報を取得
オーガニゼーションの情報を取得します。
GET
/api/v0/org
APIキーに必要な権限
- Read
応答
{ "name": <name>, "displayName": <displayName> }
| KEY | TYPE | DESCRIPTION |
|---|---|---|
name |
string | オーガニゼーションの名前。 |
displayName |
string / null | オーガニゼーションの管理名。 |
Webコンソールのアクセス制限設定の登録
Webコンソールのアクセス制限設定を登録します。
POST
/api/v0/settings/ip-restriction/web
APIキーに必要な権限
- Read
- Write
入力
以下のキーをもつオブジェクトです。
| KEY | TYPE | DESCRIPTION |
|---|---|---|
cidrs |
array[string] | オーガニゼーションのWebコンソールにアクセスできるIP範囲のCIDR記法によるホワイトリスト*1 |
応答
成功時
{ "success": true }
失敗時
| STATUS CODE | DESCRIPTION |
|---|---|
| 400 | 入力が受け付けられないフォーマットだったとき |
| 403 | APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合 |
*1 cidrs
アクセス制限を解除するには、 cidrs に [] を指定します。
Webコンソールのアクセス制限設定の取得
GET
/api/v0/settings/ip-restriction/web
APIキーに必要な権限
- Read
応答
{ "cidrs": [<cidr>,<cidr>...] }
<cidr> は、CIDR記法によるIP範囲
APIのアクセス制限設定の登録
APIのアクセス制限設定を登録します。
POST
/api/v0/settings/ip-restriction/api
APIキーに必要な権限
- Read
- Write
入力
以下のキーをもつオブジェクトです。
| KEY | TYPE | DESCRIPTION |
|---|---|---|
cidrs |
array[string] | オーガニゼーションのAPIにアクセスできるIP範囲のCIDR記法によるホワイトリスト*2 |
応答
成功時
{ "success": true }
失敗時
| STATUS CODE | DESCRIPTION |
|---|---|
| 400 | 入力が受け付けられないフォーマットだったとき |
| 403 | APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合 |
*2 cidrs
アクセス制限を解除するには、 cidrs に [] を指定します。
APIのアクセス制限設定の取得
GET
/api/v0/settings/ip-restriction/api
APIキーに必要な権限
- Read
応答
{ "cidrs": [<cidr>,<cidr>...] }
<cidr> は、CIDR記法によるIP範囲
