idp-server コントロールプレーン フェデレーション設定管理 API (1.0.0)
Download OpenAPI specification:Download
フェデレーション設定の管理API仕様書
Create federation configuration within organization tenant
組織内の特定のテナントに対して新しいフェデレーション設定を作成します
path Parameters
| organization-id required | string <uuid> 組織の識別子 |
| tenant-id required | string テナントの識別子 |
query Parameters
| dry_run | boolean Default: false ドライランモード（実際の作成は行わない） |
Request Body schema: application/jsonrequired
| id required | string <uuid> Federation configuration ID (must be UUID) |
| type required | string Enum: "oauth2" "saml2" "oidc" Federation type |
| sso_provider required | string SSO provider identifier (should be unique within tenant) |
object Federation-specific configuration payload | |
| enabled required | boolean Default: true Whether the federation configuration is enabled |
Responses
Request samples
- Payload
Content type
application/json
{- "id": "473b4179-6bed-4465-b64e-ab8969a3e8ae",
- "type": "oidc",
- "sso_provider": "google-oidc",
- "payload": {
- "client_id": "test-client-id",
- "client_secret": "test-client-secret",
}, - "enabled": true
}Response samples
- 201
- 400
- 401
- 403
- 404
- 409
Content type
application/json
{- "dry_run": true,
- "result": {
- "id": "473b4179-6bed-4465-b64e-ab8969a3e8ae",
- "type": "oidc",
- "sso_provider": "google-oidc",
- "payload": {
- "client_id": "test-client-id",
- "client_secret": "test-client-secret",
}, - "enabled": true
}
}List federation configurations within organization tenant
組織内の特定のテナントのフェデレーション設定一覧を取得します
path Parameters
| organization-id required | string <uuid> 組織の識別子 |
| tenant-id required | string テナントの識別子 |
query Parameters
| limit | integer [ 1 .. 1000 ] Default: 20 返すアイテムの最大数 |
| offset | integer >= 0 Default: 0 アイテムを返す開始インデックス |
| enabled | boolean フィルター - 有効な設定のみ取得 |
Responses
Response samples
- 200
- 401
- 403
- 404
Content type
application/json
{- "list": [
- {
- "id": "473b4179-6bed-4465-b64e-ab8969a3e8ae",
- "type": "oidc",
- "sso_provider": "google-oidc",
- "payload": {
- "client_id": "test-client-id",
- "client_secret": "test-client-secret",
}, - "enabled": true
}
], - "total_count": 0,
- "limit": 0,
- "offset": 0
}Get specific federation configuration
IDで特定のフェデレーション設定を取得します
path Parameters
| organization-id required | string <uuid> 組織の識別子 |
| tenant-id required | string テナントの識別子 |
| config-id required | string <uuid> フェデレーション設定ID |
Responses
Response samples
- 200
- 401
- 403
- 404
Content type
application/json
{- "id": "473b4179-6bed-4465-b64e-ab8969a3e8ae",
- "type": "oidc",
- "sso_provider": "google-oidc",
- "payload": {
- "client_id": "test-client-id",
- "client_secret": "test-client-secret",
}, - "enabled": true
}Update federation configuration
既存のフェデレーション設定を更新します
path Parameters
| organization-id required | string <uuid> 組織の識別子 |
| tenant-id required | string テナントの識別子 |
| config-id required | string <uuid> フェデレーション設定ID |
query Parameters
| dry_run | boolean Default: false ドライランモード（実際の更新は行わない） |
Request Body schema: application/jsonrequired
| type | string Enum: "oauth2" "saml2" "oidc" Federation type |
| sso_provider | string SSO provider identifier |
object Federation-specific configuration payload | |
| enabled | boolean Whether the federation configuration is enabled |
Responses
Request samples
- Payload
Content type
application/json
{- "type": "oauth2",
- "sso_provider": "string",
- "payload": { },
- "enabled": true
}Response samples
- 200
- 400
- 401
- 403
- 404
Content type
application/json
{- "dry_run": true,
- "result": {
- "id": "473b4179-6bed-4465-b64e-ab8969a3e8ae",
- "type": "oidc",
- "sso_provider": "google-oidc",
- "payload": {
- "client_id": "test-client-id",
- "client_secret": "test-client-secret",
}, - "enabled": true
}
}Delete federation configuration
既存のフェデレーション設定を削除します
path Parameters
| organization-id required | string <uuid> 組織の識別子 |
| tenant-id required | string テナントの識別子 |
| config-id required | string <uuid> フェデレーション設定ID |
query Parameters
| dry_run | boolean Default: false trueの場合、リクエストの検証のみで実行はされません |
Responses
Response samples
- 200
- 401
- 403
- 404
Content type
application/json
{- "message": "string",
- "config_id": "d1d31429-d888-4f1c-b9c1-4e842f9bce5b",
- "dry_run": true
}