idp-server コントロールプレーン認証設定管理 API (1.0.0)

Download OpenAPI specification:Download

認証設定、認証ポリシー、認証インタラクション、認証トランザクションの管理API仕様書

organization-authentication-interaction

組織レベル認証インタラクション管理

組織内認証インタラクション一覧取得

指定した組織・テナント内の認証インタラクション一覧を取得します（読み取り専用）

path Parameters

organization-id required	string <uuid> 組織の識別子
tenant-id required	string テナントの識別子

query Parameters

limit	integer [ 1 .. 1000 ] Default: 20 返すアイテムの最大数
offset	integer >= 0 Default: 0 アイテムを返す開始インデックス
type	string インタラクションタイプでフィルタリング
from	string <date-time> Example: from=2025-07-01T00:00:00 作成日時の範囲指定開始（ISO-8601形式）。未指定時は 7 日前
to	string <date-time> Example: to=2025-07-15T23:59:59 作成日時の範囲指定終了（ISO-8601形式）。未指定時は 1 日後

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"list": [{"transaction_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"type": "password",
"payload": {"status": "completed",
"created_at": "2025-09-18T10:30:00Z",
"metadata": { }
}
}
],
"total_count": 25,
"limit": 10,
"offset": 0
}

組織内認証インタラクション詳細取得

指定した組織・テナント内の特定の認証インタラクションの詳細を取得します

path Parameters

organization-id required	string <uuid> 組織の識別子
tenant-id required	string テナントの識別子
transaction-id required	string <uuid> Example: f47ac10b-58cc-4372-a567-0e02b2c3d479 認証トランザクションID
type required	string Example: password インタラクションタイプ

Responses

Response samples

200
401
403
404

Content type

application/json

{"transaction_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"type": "password",
"payload": {"status": "completed",
"created_at": "2025-09-18T10:30:00Z",
"metadata": { }
}
}

organization-authentication-transaction

組織レベル認証トランザクション管理

組織内認証トランザクション一覧取得

指定した組織・テナント内の認証トランザクション一覧を取得します（読み取り専用）

path Parameters

organization-id required	string <uuid> 組織の識別子
tenant-id required	string テナントの識別子

query Parameters

limit	integer [ 1 .. 1000 ] Default: 20 返すアイテムの最大数
offset	integer >= 0 Default: 0 アイテムを返す開始インデックス
id	string <uuid> 認証トランザクションIDでフィルタリング
flow	string 認証フロー種別でフィルタリング
authorization_id	string <uuid> 認可リクエストIDでフィルタリング
client_id	string クライアントIDでフィルタリング
device_id	string <uuid> 認証デバイスIDでフィルタリング
from	string <date-time> Example: from=2025-07-01T00:00:00 作成日時の範囲指定開始（ISO-8601形式）
to	string <date-time> Example: to=2025-07-15T23:59:59 作成日時の範囲指定終了（ISO-8601形式）
exclude_expired	boolean Default: true 有効期限切れを除外するか
attributes.key	string 属性情報のオブジェクトのkeyに対する検索（keyは具体的な値に変更が必要）

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"list": [{"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"client_id": "example-client-001",
"redirect_uri": "https://example.com/callback",
"scope": "openid profile email",
"state": "random-state-value",
"nonce": "random-nonce-value",
"response_type": "code",
"code_challenge": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk",
"code_challenge_method": "S256"
}
],
"total_count": 15,
"limit": 10,
"offset": 0
}

組織内認証トランザクション詳細取得

指定した組織・テナント内の特定の認証トランザクションの詳細を取得します

path Parameters

organization-id required	string <uuid> 組織の識別子
tenant-id required	string テナントの識別子
transaction-id required	string <uuid> Example: f47ac10b-58cc-4372-a567-0e02b2c3d479 認証トランザクションID

Responses

Response samples

200
401
403
404

Content type

application/json

{"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"client_id": "example-client-001",
"redirect_uri": "https://example.com/callback",
"scope": "openid profile email",
"state": "random-state-value",
"nonce": "random-nonce-value",
"response_type": "code",
"code_challenge": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk",
"code_challenge_method": "S256"
}

organization-authentication-config

Create authentication configuration within organization

組織内の特定のテナントに対して新しい認証設定を作成します

path Parameters

organization-id required	string <uuid> 組織の識別子
tenant-id required	string テナントの識別子

query Parameters

dry_run

boolean

Default: false

trueの場合、リクエストの検証のみで実行はされません

Request Body schema: application/json
optional

id	string <uuid> 設定識別子
type	string 認証設定タイプ
	object Configuration-specific attributes
	object 設定メタデータ
	object 認証インタラクション設定 mapping
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"attributes": { },
"metadata": { },
"interactions": {"property1": {"request": {"schema": { }
},
"preHook": {"additional_parameters": [{ }
]
},
"execution": {"function": "string",
"previous_interaction": { },
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { },
"http_request_store": { },
"http_requests_store": { }
},
"userResolve": {"user_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"postHook": {"additional_parameters": [{"function": "string",
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { }
}
],
"verifications": [{"type": "match",
"details": {"rules": [{"path": "string",
"target_path": "string",
"operation": "eq"
}
]
}
}
]
},
"response": {"body_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
},
"property2": {"request": {"schema": { }
},
"preHook": {"additional_parameters": [{ }
]
},
"execution": {"function": "string",
"previous_interaction": { },
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { },
"http_request_store": { },
"http_requests_store": { }
},
"userResolve": {"user_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"postHook": {"additional_parameters": [{"function": "string",
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { }
}
],
"verifications": [{"type": "match",
"details": {"rules": [{"path": "string",
"target_path": "string",
"operation": "eq"
}
]
}
}
]
},
"response": {"body_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
}
}
}

Response samples

200
400
403
404

Content type

application/json

{"dry_run": true,
"result": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"attributes": { },
"metadata": { },
"interactions": {"property1": {"request": {"schema": { }
},
"preHook": {"additional_parameters": [{ }
]
},
"execution": {"function": "string",
"previous_interaction": { },
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { },
"http_request_store": { },
"http_requests_store": { }
},
"userResolve": {"user_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"postHook": {"additional_parameters": [{"function": "string",
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { }
}
],
"verifications": [{"type": "match",
"details": {"rules": [{"path": null,
"target_path": null,
"operation": null
}
]
}
}
]
},
"response": {"body_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
},
"property2": {"request": {"schema": { }
},
"preHook": {"additional_parameters": [{ }
]
},
"execution": {"function": "string",
"previous_interaction": { },
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { },
"http_request_store": { },
"http_requests_store": { }
},
"userResolve": {"user_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"postHook": {"additional_parameters": [{"function": "string",
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { }
}
],
"verifications": [{"type": "match",
"details": {"rules": [{"path": null,
"target_path": null,
"operation": null
}
]
}
}
]
},
"response": {"body_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

List authentication configurations within organization

組織内の特定のテナントの認証設定一覧を取得します

path Parameters

organization-id required	string <uuid> 組織の識別子
tenant-id required	string テナントの識別子

query Parameters

limit	integer [ 1 .. 1000 ] Default: 20 返すアイテムの最大数
offset	integer >= 0 Default: 0 アイテムを返す開始インデックス

Responses

Response samples

200
403
404

Content type

application/json

{"list": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"attributes": { },
"metadata": { },
"interactions": {"property1": {"request": {"schema": { }
},
"preHook": {"additional_parameters": [{ }
]
},
"execution": {"function": "string",
"previous_interaction": { },
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { },
"http_request_store": { },
"http_requests_store": { }
},
"userResolve": {"user_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"postHook": {"additional_parameters": [{"function": "string",
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { }
}
],
"verifications": [{"type": "match",
"details": {"rules": [{ }
]
}
}
]
},
"response": {"body_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
},
"property2": {"request": {"schema": { }
},
"preHook": {"additional_parameters": [{ }
]
},
"execution": {"function": "string",
"previous_interaction": { },
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { },
"http_request_store": { },
"http_requests_store": { }
},
"userResolve": {"user_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"postHook": {"additional_parameters": [{"function": "string",
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { }
}
],
"verifications": [{"type": "match",
"details": {"rules": [{ }
]
}
}
]
},
"response": {"body_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_count": 0,
"limit": 0,
"offset": 0
}

Get authentication configuration by ID within organization

組織内の特定のテナントの認証設定詳細を取得します

path Parameters

organization-id required	string <uuid> 組織の識別子
tenant-id required	string テナントの識別子
config-id required	string <uuid> 認証設定の識別子

Responses

Response samples

200
403
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"attributes": { },
"metadata": { },
"interactions": {"property1": {"request": {"schema": { }
},
"preHook": {"additional_parameters": [{ }
]
},
"execution": {"function": "string",
"previous_interaction": { },
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { },
"http_request_store": { },
"http_requests_store": { }
},
"userResolve": {"user_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"postHook": {"additional_parameters": [{"function": "string",
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { }
}
],
"verifications": [{"type": "match",
"details": {"rules": [{"path": "string",
"target_path": "string",
"operation": "eq"
}
]
}
}
]
},
"response": {"body_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
},
"property2": {"request": {"schema": { }
},
"preHook": {"additional_parameters": [{ }
]
},
"execution": {"function": "string",
"previous_interaction": { },
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { },
"http_request_store": { },
"http_requests_store": { }
},
"userResolve": {"user_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"postHook": {"additional_parameters": [{"function": "string",
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { }
}
],
"verifications": [{"type": "match",
"details": {"rules": [{"path": "string",
"target_path": "string",
"operation": "eq"
}
]
}
}
]
},
"response": {"body_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update authentication configuration by ID within organization

組織内の特定のテナントの認証設定を更新します

path Parameters

organization-id required	string <uuid> 組織の識別子
tenant-id required	string テナントの識別子
config-id required	string <uuid> 認証設定の識別子

query Parameters

dry_run

boolean

Default: false

trueの場合、リクエストの検証のみで実行はされません

Request Body schema: application/json
optional

id	string <uuid> 設定識別子
type	string 認証設定タイプ
	object Configuration-specific attributes
	object 設定メタデータ
	object 認証インタラクション設定 mapping
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"attributes": { },
"metadata": { },
"interactions": {"property1": {"request": {"schema": { }
},
"preHook": {"additional_parameters": [{ }
]
},
"execution": {"function": "string",
"previous_interaction": { },
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { },
"http_request_store": { },
"http_requests_store": { }
},
"userResolve": {"user_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"postHook": {"additional_parameters": [{"function": "string",
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { }
}
],
"verifications": [{"type": "match",
"details": {"rules": [{"path": "string",
"target_path": "string",
"operation": "eq"
}
]
}
}
]
},
"response": {"body_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
},
"property2": {"request": {"schema": { }
},
"preHook": {"additional_parameters": [{ }
]
},
"execution": {"function": "string",
"previous_interaction": { },
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { },
"http_request_store": { },
"http_requests_store": { }
},
"userResolve": {"user_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"postHook": {"additional_parameters": [{"function": "string",
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { }
}
],
"verifications": [{"type": "match",
"details": {"rules": [{"path": "string",
"target_path": "string",
"operation": "eq"
}
]
}
}
]
},
"response": {"body_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
}
}
}

Response samples

200
400
403
404

Content type

application/json

{"dry_run": true,
"result": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"attributes": { },
"metadata": { },
"interactions": {"property1": {"request": {"schema": { }
},
"preHook": {"additional_parameters": [{ }
]
},
"execution": {"function": "string",
"previous_interaction": { },
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { },
"http_request_store": { },
"http_requests_store": { }
},
"userResolve": {"user_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"postHook": {"additional_parameters": [{"function": "string",
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { }
}
],
"verifications": [{"type": "match",
"details": {"rules": [{"path": null,
"target_path": null,
"operation": null
}
]
}
}
]
},
"response": {"body_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
},
"property2": {"request": {"schema": { }
},
"preHook": {"additional_parameters": [{ }
]
},
"execution": {"function": "string",
"previous_interaction": { },
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { },
"http_request_store": { },
"http_requests_store": { }
},
"userResolve": {"user_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"postHook": {"additional_parameters": [{"function": "string",
"http_request": { },
"http_requests": [{ }
],
"mock": { },
"details": { }
}
],
"verifications": [{"type": "match",
"details": {"rules": [{"path": null,
"target_path": null,
"operation": null
}
]
}
}
]
},
"response": {"body_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
}
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete authentication configuration by ID within organization

組織内の特定のテナントの認証設定を削除します

path Parameters

organization-id required	string <uuid> 組織の識別子
tenant-id required	string テナントの識別子
config-id required	string <uuid> 認証設定の識別子

query Parameters

dry_run

boolean

Default: false

trueの場合、リクエストの検証のみで実行はされません

Responses

Response samples

200
403
404

Content type

application/json

{"message": "string",
"config_id": "d1d31429-d888-4f1c-b9c1-4e842f9bce5b",
"dry_run": true
}

organization-authentication-policy-config

Create authentication policy configuration within organization

組織内の特定のテナントに対して新しい認証ポリシー設定を作成します

path Parameters

organization-id required	string <uuid> 組織の識別子
tenant-id required	string テナントの識別子

query Parameters

dry_run

boolean

Default: false

trueの場合、リクエストの検証のみで実行はされません

Request Body schema: application/json
optional

id	string <uuid> Authentication policy configuration identifier
flow	string Authentication flow type
	Array of objects (AuthenticationPolicy) List of authentication policies
enabled	boolean Default: true Whether the policy configuration is enabled
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"flow": "string",
"policies": [{"priority": 0,
"conditions": {"client_ids": ["string"
],
"acr_values": ["string"
],
"scopes": ["string"
]
},
"available_methods": ["string"
],
"acr_mapping_rules": {"property1": ["string"
],
"property2": ["string"
]
},
"level_of_authentication_scopes": {"property1": ["string"
],
"property2": ["string"
]
},
"success_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"failure_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"lock_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"device_registration_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"step_definitions": [{"method": "password",
"interaction": "identify",
"order": 1,
"requires_user": false,
"allow_registration": false,
"registration_mode": "allowed",
"user_identity_source": "email",
"verification_source": "string"
}
],
"auth_session_binding_required": true,
"custom_params_trusted_sources": ["pushed",
"request_object"
]
}
],
"enabled": true
}

Response samples

201
400
403
404

Content type

application/json

{"dry_run": false,
"result": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"flow": "string",
"policies": [{"priority": 0,
"conditions": {"client_ids": ["string"
],
"acr_values": ["string"
],
"scopes": ["string"
]
},
"available_methods": ["string"
],
"acr_mapping_rules": {"property1": ["string"
],
"property2": ["string"
]
},
"level_of_authentication_scopes": {"property1": ["string"
],
"property2": ["string"
]
},
"success_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"failure_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"lock_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"device_registration_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"step_definitions": [{"method": "password",
"interaction": "identify",
"order": 1,
"requires_user": false,
"allow_registration": false,
"registration_mode": "allowed",
"user_identity_source": "email",
"verification_source": "string"
}
],
"auth_session_binding_required": true,
"custom_params_trusted_sources": ["pushed",
"request_object"
]
}
],
"enabled": true,
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

List authentication policy configurations within organization

組織内の特定のテナントの認証ポリシー設定一覧を取得します

path Parameters

organization-id required	string <uuid> 組織の識別子
tenant-id required	string テナントの識別子

query Parameters

limit	integer [ 1 .. 1000 ] Default: 20 返すアイテムの最大数
offset	integer >= 0 Default: 0 アイテムを返す開始インデックス

Responses

Response samples

200
403
404

Content type

application/json

{"list": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"flow": "string",
"policies": [{"priority": 0,
"conditions": {"client_ids": ["string"
],
"acr_values": ["string"
],
"scopes": ["string"
]
},
"available_methods": ["string"
],
"acr_mapping_rules": {"property1": ["string"
],
"property2": ["string"
]
},
"level_of_authentication_scopes": {"property1": ["string"
],
"property2": ["string"
]
},
"success_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"failure_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"lock_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"device_registration_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"step_definitions": [{"method": "password",
"interaction": "identify",
"order": 1,
"requires_user": false,
"allow_registration": false,
"registration_mode": "allowed",
"user_identity_source": "email",
"verification_source": "string"
}
],
"auth_session_binding_required": true,
"custom_params_trusted_sources": ["pushed",
"request_object"
]
}
],
"enabled": true,
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_count": 0,
"limit": 0,
"offset": 0
}

Get authentication policy configuration by ID within organization

組織内の特定のテナントの認証ポリシー設定詳細を取得します

path Parameters

organization-id required	string <uuid> 組織の識別子
tenant-id required	string テナントの識別子
config-id required	string <uuid> 認証ポリシー設定の識別子

Responses

Response samples

200
403
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"flow": "string",
"policies": [{"priority": 0,
"conditions": {"client_ids": ["string"
],
"acr_values": ["string"
],
"scopes": ["string"
]
},
"available_methods": ["string"
],
"acr_mapping_rules": {"property1": ["string"
],
"property2": ["string"
]
},
"level_of_authentication_scopes": {"property1": ["string"
],
"property2": ["string"
]
},
"success_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"failure_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"lock_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"device_registration_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"step_definitions": [{"method": "password",
"interaction": "identify",
"order": 1,
"requires_user": false,
"allow_registration": false,
"registration_mode": "allowed",
"user_identity_source": "email",
"verification_source": "string"
}
],
"auth_session_binding_required": true,
"custom_params_trusted_sources": ["pushed",
"request_object"
]
}
],
"enabled": true,
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update authentication policy configuration by ID within organization

組織内の特定のテナントの認証ポリシー設定を更新します

path Parameters

organization-id required	string <uuid> 組織の識別子
tenant-id required	string テナントの識別子
config-id required	string <uuid> 認証ポリシー設定の識別子

query Parameters

dry_run

boolean

Default: false

trueの場合、リクエストの検証のみで実行はされません

Request Body schema: application/json
optional

id	string <uuid> Authentication policy configuration identifier
flow	string Authentication flow type
	Array of objects (AuthenticationPolicy) List of authentication policies
enabled	boolean Default: true Whether the policy configuration is enabled
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"flow": "string",
"policies": [{"priority": 0,
"conditions": {"client_ids": ["string"
],
"acr_values": ["string"
],
"scopes": ["string"
]
},
"available_methods": ["string"
],
"acr_mapping_rules": {"property1": ["string"
],
"property2": ["string"
]
},
"level_of_authentication_scopes": {"property1": ["string"
],
"property2": ["string"
]
},
"success_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"failure_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"lock_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"device_registration_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"step_definitions": [{"method": "password",
"interaction": "identify",
"order": 1,
"requires_user": false,
"allow_registration": false,
"registration_mode": "allowed",
"user_identity_source": "email",
"verification_source": "string"
}
],
"auth_session_binding_required": true,
"custom_params_trusted_sources": ["pushed",
"request_object"
]
}
],
"enabled": true
}

Response samples

200
400
403
404

Content type

application/json

{"dry_run": true,
"result": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"flow": "string",
"policies": [{"priority": 0,
"conditions": {"client_ids": ["string"
],
"acr_values": ["string"
],
"scopes": ["string"
]
},
"available_methods": ["string"
],
"acr_mapping_rules": {"property1": ["string"
],
"property2": ["string"
]
},
"level_of_authentication_scopes": {"property1": ["string"
],
"property2": ["string"
]
},
"success_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"failure_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"lock_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"device_registration_conditions": {"any_of": [[{"path": "$.password-authentication.success_count",
"type": "integer",
"operation": "eq",
"value": 1,
"value_path": "$.user.custom_properties.member_no"
}
]
]
},
"step_definitions": [{"method": "password",
"interaction": "identify",
"order": 1,
"requires_user": false,
"allow_registration": false,
"registration_mode": "allowed",
"user_identity_source": "email",
"verification_source": "string"
}
],
"auth_session_binding_required": true,
"custom_params_trusted_sources": ["pushed",
"request_object"
]
}
],
"enabled": true,
"tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

Delete authentication policy configuration by ID within organization

組織内の特定のテナントの認証ポリシー設定を削除します

path Parameters

organization-id required	string <uuid> 組織の識別子
tenant-id required	string テナントの識別子
config-id required	string <uuid> 認証ポリシー設定の識別子

query Parameters

dry_run

boolean

Default: false

trueの場合、リクエストの検証のみで実行はされません

Responses

Response samples

403
404

Content type

application/json

{"error": "string",
"error_description": "string",
"error_messages": ["string"
],
"error_details": { }
}

idp-server コントロールプレーン 認証設定管理 API (1.0.0)

organization-authentication-interaction

組織内認証インタラクション一覧取得

path Parameters

query Parameters

Responses

Response samples

組織内認証インタラクション詳細取得

path Parameters

Responses

Response samples

organization-authentication-transaction

組織内認証トランザクション一覧取得

path Parameters

query Parameters

Responses

Response samples

組織内認証トランザクション詳細取得

path Parameters

Responses

Response samples

organization-authentication-config

Create authentication configuration within organization

path Parameters

query Parameters

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

List authentication configurations within organization

path Parameters

query Parameters

Responses

Response samples

Get authentication configuration by ID within organization

path Parameters

Responses

Response samples

Update authentication configuration by ID within organization

path Parameters

query Parameters

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Delete authentication configuration by ID within organization

path Parameters

query Parameters

Responses

Response samples

organization-authentication-policy-config

Create authentication policy configuration within organization

path Parameters

query Parameters

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

List authentication policy configurations within organization

path Parameters

query Parameters

Responses

Response samples

Get authentication policy configuration by ID within organization

path Parameters

Responses

Response samples

Update authentication policy configuration by ID within organization

path Parameters

query Parameters

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Delete authentication policy configuration by ID within organization

path Parameters

query Parameters

Responses

Response samples

idp-server コントロールプレーン認証設定管理 API (1.0.0)

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional