Authorization Endpoint における ticket パラメーターの特性

Authlete の Authorization Endpoint API は、お客さまが認可サーバーの認可エンドポイントを実装する上での、バックエンドとなる機能を提供します。同 API は大別して 2 種類あります。

1. 認可リクエストを解析し、認可サーバーにおける「次の処理（ユーザー認証など）」に必要な情報を返却する API

   • /auth/authorization

2. 「次の処理」の後、トークンや認可コードを発行する、もしくはエラーを返却する API

   • /auth/authorization/fail （ご参考: “fail” API を用いたエラーレスポンスの生成 ）, /auth/authorization/issue

これら 2 つの API をひもづけるパラメーターが “ticket” です。Authlete は、まず /auth/authorization API のレスポンスとして ticket を返却します。そして ticket を再び /auth/authorization/fail, /auth/authorization/issue API の引数として受け取ることにより、認可リクエストの内容に応じたトークン発行やエラー処理生成を行うことができるようになります。

ticket パラメーターには以下の特性があります。

• 有効期限は 24 時間です。有効期限を超えた ticket は Authlete のデータベースから削除されます。

• 2 回以上用いることはできません。当該 ticket を Authlete が API の引数として受け取り、処理に成功した時点で、その ticket は Authlete のデータベースから削除されます。

• ticket が Authlete のデータベースから削除された後に、再度当該 ticket を引数として受け取った場合には、Authlete は以下のエラーを返却します。（ご参考: Authlete の result code について ）

  + A041202
  There is no entity having the ticket specified in the /api/auth/authorization/issue request (ticket = {Ticket}).
  

• 認可サーバーと Authlete の Authorization Endpoint API とのやりとり以外の用途、たとえば認可サーバーとユーザーエージェント（Web ブラウザなど）との間のセッション管理などに ticket の値を直接用いることは想定されていません。