メインコンテンツまでスキップ

idp-server システムレベル管理 API (1.0.0)

Download OpenAPI specification:Download

idp-server システムレベル管理 API 仕様書

システム全体に適用される設定を管理するAPIです。 これらのAPIはシステム管理者権限(system:read, system:write)が必要です。

system-configuration

システム設定管理(SSRF保護、信頼するプロキシ等)

システム設定を取得

現在のシステム設定を取得します。

必要な権限: system:read

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "ssrf_protection": {
    },
  • "trusted_proxies": {
    }
}

システム設定を更新

システム設定を更新します。

必要な権限: system:write

Dry Run: ?dry_run=true を指定すると、実際の更新は行わずにバリデーションのみ実行します。

Authorizations:
bearerAuth
query Parameters
dry_run
boolean
Default: false

trueの場合、バリデーションのみ実行し実際の更新は行いません

Request Body schema: application/json
required
object (SsrfProtectionConfig)

SSRF(Server-Side Request Forgery)保護設定

外部HTTPリクエスト時にプライベートIPへのアクセスをブロックします。

object (TrustedProxyConfig)

信頼するプロキシ設定

X-Forwarded-Forヘッダーからクライアントの実IPを取得する際の信頼設定です。 ロードバランサーやリバースプロキシの背後で動作する場合に設定します。

Responses

Request samples

Content type
application/json
{
  • "ssrf_protection": {
    },
  • "trusted_proxies": {
    }
}

Response samples

Content type
application/json
{
  • "status": "updated",
  • "dry_run": false,
  • "configuration": {
    }
}