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

Download OpenAPI specification:Download

身元確認設定の管理API仕様書

organization-identity-verification

組織レベル身元確認設定管理

組織内身元確認設定作成

指定した組織・テナント内に新しい身元確認設定を作成します

path Parameters

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

query Parameters

dry_run

boolean

Default: false

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

Request Body schema: application/json
required

id required	string <uuid> Identity verification configuration ID (must be UUID)
type required	string Identity verification configuration type
enabled	boolean Default: true Whether the identity verification configuration is enabled
	object 設定属性
	object (IdentityVerificationCommonConfiguration)
	object Process configurations by name
	object (IdentityVerificationRegistrationConfig)
	object (IdentityVerificationResultConfig)

Responses

Request samples

Payload

Content type

application/json

{"id": "473b4179-6bed-4465-b64e-ab8969a3e8ae",
"type": "document_verification",
"enabled": true,
"attributes": { },
"common": {"callback_application_id_param": "string",
"auth_type": "string",
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"processes": {"property1": {"request": {"basic_auth": {"username": "string",
"password": "string"
},
"schema": { }
},
"pre_hook": { },
"execution": {"http_request": {"url": "http://example.com",
"method": "GET",
"headers": {"property1": "string",
"property2": "string"
},
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"mock": {"enabled": true,
"response": { }
}
},
"post_hook": { },
"transition": {"approved": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"rejected": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"canceled": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
}
},
"store": {"enabled": true,
"mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"response": {"template": "string",
"content_type": "string"
}
},
"property2": {"request": {"basic_auth": {"username": "string",
"password": "string"
},
"schema": { }
},
"pre_hook": { },
"execution": {"http_request": {"url": "http://example.com",
"method": "GET",
"headers": {"property1": "string",
"property2": "string"
},
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"mock": {"enabled": true,
"response": { }
}
},
"post_hook": { },
"transition": {"approved": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"rejected": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"canceled": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
}
},
"store": {"enabled": true,
"mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"response": {"template": "string",
"content_type": "string"
}
}
},
"registration": {"enabled": true,
"auto_registration": true,
"required_attributes": ["string"
]
},
"result": {"verified_claims_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
],
"source_details_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
}

Response samples

Content type

application/json

{"dry_run": false,
"result": {"id": "473b4179-6bed-4465-b64e-ab8969a3e8ae",
"type": "document_verification",
"enabled": true,
"attributes": { },
"common": {"callback_application_id_param": "string",
"auth_type": "string",
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"processes": {"property1": {"request": {"basic_auth": {"username": "string",
"password": "string"
},
"schema": { }
},
"pre_hook": { },
"execution": {"http_request": {"url": "http://example.com",
"method": "GET",
"headers": {"property1": "string",
"property2": "string"
},
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"mock": {"enabled": true,
"response": { }
}
},
"post_hook": { },
"transition": {"approved": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"rejected": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"canceled": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
}
},
"store": {"enabled": true,
"mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"response": {"template": "string",
"content_type": "string"
}
},
"property2": {"request": {"basic_auth": {"username": "string",
"password": "string"
},
"schema": { }
},
"pre_hook": { },
"execution": {"http_request": {"url": "http://example.com",
"method": "GET",
"headers": {"property1": "string",
"property2": "string"
},
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"mock": {"enabled": true,
"response": { }
}
},
"post_hook": { },
"transition": {"approved": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"rejected": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"canceled": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
}
},
"store": {"enabled": true,
"mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"response": {"template": "string",
"content_type": "string"
}
}
},
"registration": {"enabled": true,
"auto_registration": true,
"required_attributes": ["string"
]
},
"result": {"verified_claims_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
],
"source_details_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
}
}

組織内身元確認設定一覧取得

指定した組織・テナント内の身元確認設定一覧を取得します

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 設定IDでフィルタリング
type	string 検証タイプでフィルタリング
from	string <date-time> 作成日時の開始（ISO 8601形式）
to	string <date-time> 作成日時の終了（ISO 8601形式）
dry_run	boolean Default: false trueの場合、リクエストの検証のみで実行はされません

Responses

Response samples

Content type

application/json

{"list": [{"id": "473b4179-6bed-4465-b64e-ab8969a3e8ae",
"type": "document_verification",
"enabled": true,
"attributes": { },
"common": {"callback_application_id_param": "string",
"auth_type": "string",
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"processes": {"property1": {"request": {"basic_auth": {"username": "string",
"password": "string"
},
"schema": { }
},
"pre_hook": { },
"execution": {"http_request": {"url": "http://example.com",
"method": "GET",
"headers": {"property1": "string",
"property2": "string"
},
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"mock": {"enabled": true,
"response": { }
}
},
"post_hook": { },
"transition": {"approved": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"rejected": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"canceled": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
}
},
"store": {"enabled": true,
"mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"response": {"template": "string",
"content_type": "string"
}
},
"property2": {"request": {"basic_auth": {"username": "string",
"password": "string"
},
"schema": { }
},
"pre_hook": { },
"execution": {"http_request": {"url": "http://example.com",
"method": "GET",
"headers": {"property1": "string",
"property2": "string"
},
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"mock": {"enabled": true,
"response": { }
}
},
"post_hook": { },
"transition": {"approved": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"rejected": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"canceled": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
}
},
"store": {"enabled": true,
"mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"response": {"template": "string",
"content_type": "string"
}
}
},
"registration": {"enabled": true,
"auto_registration": true,
"required_attributes": ["string"
]
},
"result": {"verified_claims_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
],
"source_details_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
}
],
"total_count": 0,
"limit": 0,
"offset": 0
}

組織内身元確認設定詳細取得

指定した組織・テナント内の特定の身元確認設定の詳細を取得します

path Parameters

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

Responses

Response samples

Content type

application/json

{"id": "473b4179-6bed-4465-b64e-ab8969a3e8ae",
"type": "document_verification",
"enabled": true,
"attributes": { },
"common": {"callback_application_id_param": "string",
"auth_type": "string",
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"processes": {"property1": {"request": {"basic_auth": {"username": "string",
"password": "string"
},
"schema": { }
},
"pre_hook": { },
"execution": {"http_request": {"url": "http://example.com",
"method": "GET",
"headers": {"property1": "string",
"property2": "string"
},
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"mock": {"enabled": true,
"response": { }
}
},
"post_hook": { },
"transition": {"approved": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"rejected": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"canceled": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
}
},
"store": {"enabled": true,
"mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"response": {"template": "string",
"content_type": "string"
}
},
"property2": {"request": {"basic_auth": {"username": "string",
"password": "string"
},
"schema": { }
},
"pre_hook": { },
"execution": {"http_request": {"url": "http://example.com",
"method": "GET",
"headers": {"property1": "string",
"property2": "string"
},
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"mock": {"enabled": true,
"response": { }
}
},
"post_hook": { },
"transition": {"approved": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"rejected": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"canceled": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
}
},
"store": {"enabled": true,
"mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"response": {"template": "string",
"content_type": "string"
}
}
},
"registration": {"enabled": true,
"auto_registration": true,
"required_attributes": ["string"
]
},
"result": {"verified_claims_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
],
"source_details_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
}

組織内身元確認設定更新

指定した組織・テナント内の特定の身元確認設定を更新します

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
required

type	string Identity verification configuration type
enabled	boolean Whether the identity verification configuration is enabled
	object 設定属性
	object (IdentityVerificationCommonConfiguration)
	object Process configurations by name
	object (IdentityVerificationRegistrationConfig)
	object (IdentityVerificationResultConfig)

Responses

Request samples

Payload

Content type

application/json

{"type": "enhanced_document_verification",
"enabled": true,
"attributes": { },
"common": {"callback_application_id_param": "string",
"auth_type": "string",
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"processes": {"property1": {"request": {"basic_auth": {"username": "string",
"password": "string"
},
"schema": { }
},
"pre_hook": { },
"execution": {"http_request": {"url": "http://example.com",
"method": "GET",
"headers": {"property1": "string",
"property2": "string"
},
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"mock": {"enabled": true,
"response": { }
}
},
"post_hook": { },
"transition": {"approved": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"rejected": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"canceled": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
}
},
"store": {"enabled": true,
"mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"response": {"template": "string",
"content_type": "string"
}
},
"property2": {"request": {"basic_auth": {"username": "string",
"password": "string"
},
"schema": { }
},
"pre_hook": { },
"execution": {"http_request": {"url": "http://example.com",
"method": "GET",
"headers": {"property1": "string",
"property2": "string"
},
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"mock": {"enabled": true,
"response": { }
}
},
"post_hook": { },
"transition": {"approved": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"rejected": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"canceled": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
}
},
"store": {"enabled": true,
"mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"response": {"template": "string",
"content_type": "string"
}
}
},
"registration": {"enabled": true,
"auto_registration": true,
"required_attributes": ["string"
]
},
"result": {"verified_claims_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
],
"source_details_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
}

Response samples

Content type

application/json

{"dry_run": false,
"result": {"id": "473b4179-6bed-4465-b64e-ab8969a3e8ae",
"type": "document_verification",
"enabled": true,
"attributes": { },
"common": {"callback_application_id_param": "string",
"auth_type": "string",
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"processes": {"property1": {"request": {"basic_auth": {"username": "string",
"password": "string"
},
"schema": { }
},
"pre_hook": { },
"execution": {"http_request": {"url": "http://example.com",
"method": "GET",
"headers": {"property1": "string",
"property2": "string"
},
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"mock": {"enabled": true,
"response": { }
}
},
"post_hook": { },
"transition": {"approved": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"rejected": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"canceled": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
}
},
"store": {"enabled": true,
"mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"response": {"template": "string",
"content_type": "string"
}
},
"property2": {"request": {"basic_auth": {"username": "string",
"password": "string"
},
"schema": { }
},
"pre_hook": { },
"execution": {"http_request": {"url": "http://example.com",
"method": "GET",
"headers": {"property1": "string",
"property2": "string"
},
"oauth_authorization": {"client_id": "string",
"client_secret": "string",
"token_endpoint": "http://example.com",
"scope": "string"
},
"hmac_authentication": {"secret_key": "string",
"algorithm": "HmacSHA256",
"header_name": "string"
}
},
"mock": {"enabled": true,
"response": { }
}
},
"post_hook": { },
"transition": {"approved": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"rejected": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
},
"canceled": {"conditions": [{"path": "string",
"operator": "eq",
"value": null,
"type": "string"
}
]
}
},
"store": {"enabled": true,
"mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
},
"response": {"template": "string",
"content_type": "string"
}
}
},
"registration": {"enabled": true,
"auto_registration": true,
"required_attributes": ["string"
]
},
"result": {"verified_claims_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
],
"source_details_mapping_rules": [{"from": "string",
"static_value": null,
"to": "string",
"convert_type": "string",
"functions": [{ }
]
}
]
}
}
}

組織内身元確認設定削除

指定した組織・テナント内の特定の身元確認設定を削除します

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

Content type

application/json

{"error": "unauthorized",
"error_description": "Authentication required"
}

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

organization-identity-verification

組織内身元確認設定作成

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

組織内身元確認設定一覧取得

path Parameters

query Parameters

Responses

Response samples

組織内身元確認設定詳細取得

path Parameters

Responses

Response samples

組織内身元確認設定更新

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

組織内身元確認設定削除

path Parameters

query Parameters

Responses

Response samples

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

Request Body schema: application/json
required

Request Body schema: application/json
required