セッションの中止

概要

セッションが不要になった場合に中止します。これにより、中止した "request_id" に対してそれ以上のメッセージが送信されなくなります。進行中のワークフローのステップはすべて中止されます。

エンドポイント URL: https://api.cpaas.symphony.rakuten.net/twofa/v1/cancel/$request_id

メソッド: POST

HTTP ヘッダー

パラメーター	要否	値
Authentication	必須	Type: Bearer Token: JWT Token
Accept	必須	application/json
Content-Type	必須	application/json; charset=UTF-8

リクエストボディスキーマ： application/json

パラメーター	要否	詳細/値
request_id	必須	"request_id" は、新しい PIN が要求されたときにプラットフォームから返されます

レスポンス:

成功した場合は、APIの呼び出しに対するレスポンスがJson形式で 200 OKとなります。失敗時のレスポンスの詳細は"エラーコード"を参照してください

パラメーター	概要
success	Tこのパラメーターはセッションの結果を表し、PIN が正しく送信された場合、PIN が正しく検証された場合などに"true" を返し、PIN が無効または間違っていた場合、またはセッションがキャンセルされた場合には "false" を返します。
result_code	結果コードを参照する
result_message	結果コードの詳細
client_reference	クライアント証明書はリクエストで指定されたときのみ返されます。"client reference" は "Additional/Advanced Options" の下で確認することができます。
request_id	リクエストで提供された "request_id"が参照用として返されます。

サンプルレスポンス

{
  "success" : false,	
  "result_code" : 215,
  "result_message" : "The requested session has been cancelled",
  "client_reference": "...if provided during original request...",
  "request_id" : "...the request_id provided in the request is returned for reference..."
}

セッションの中止

概要​

概要