リフレッシュ・トークン

OAuth 認証を使用している場合、リフレッシュ・トークンを有効にすることができます。リフレッシュ・トークンは、現行のアクセス・トークンが無効または期限切れになったときに新規アクセス・トークンを取得するため、または同じスコープあるいはより狭いスコープの追加アクセス・トークンを取得するために、クライアントに対して発行されます。

OAuth 認証を使用している場合、Authorization HTTP ヘッダーを使用して、API 要求に有効なアクセス・トークンを含める必要があります。アクセス・トークンは、IBM® API Connect トークン・エンドポイントによって発行され、デフォルトで有効期限は 3600 秒 (1 時間) です。これは、トークン要求で返される expires_in プロパティーで示されています。以下のコード・ブロックは、Authorization ヘッダーを使用した API 要求の例を示しています。

GET /bankingApi/accountSummary?client_id=32427ce5-bb7c-48a7-9de3-4bb629091103
HTTP/1.1
Accept: application/json
Host: api.ibm.com
Authorization: Bearer AAEFYy1hbGxlhdS5nVX4x6iTL2sb3ymBivQb... 

OAuth プロバイダー構成の「トークン」 > 「リフレッシュ・トークン」画面でこのオプションが有効になっている場合は、アクセス・トークンの期限が切れた後も、アプリケーションでリフレッシュ・トークンを使用します。各リフレッシュ・トークンは、発行後およそ 31 日間 (または指定された存続時間) 有効で、新規アクセス・トークンを要求するために 1 回のみ使用することができます。新規アクセス・トークンとともに、新規リフレッシュ・トークンも返されます。リフレッシュ・トークンを有効にする方法について詳しくは、ネイティブ OAuth プロバイダーの構成を参照してください。

アクセス・トークンの有効期限が切れ、かつ、アプリケーションでリフレッシュ・トークンを使用していない場合は、OAuth プロバイダーで許可される権限付与タイプを選択して OAuth 交換を再始動する必要があります。