コンテンツにスキップ

認証コードの生成



POST /api/v1/offline_token/temporary_auth_code/create

概要

1回限りの認証コードを生成します

Body リクエストパラメータ

パラメータ名 タイプ 必須 説明
roles array ロールリスト UUID
例: ['readOnly']
空を許可: False
roles[*] string Y ロール識別子
空を許可: False
expires integer Y トークンの有効期限(秒)
例: 3600
空を許可: False
$maxValue: 604800
$minValue: 1

パラメータ補足説明

使用説明


このエンドポイントはトークンを直接返さず、1回限りの authCode のみを返します。 認証情報をページパラメータでフロントエンドに渡す必要があるが、実際のトークンを直接公開したくない場合に適しています。

  1. 認証不要の中間ページのURL /redirect_auth/{authCode}?overwrite=true&to=xxx を組み立てます。中間ページは authCode を実際のトークンと交換します。
  2. パラメータ overwrite=true は、現在ログイン中のトークンを上書きすることを示します(デフォルトでは省略可能で、一時トークンとして扱われます)。
  3. パラメータ to=xxx は、遷移先のページアドレス(相対アドレス)を示します。
  4. 交換が成功すると authCode は直ちに無効になります。引き続き使用する必要がない場合は、POST /offline_token/temporary_auth_code/revoke を呼び出して明示的に無効にできます。

注意事項


  1. authCode は1回のみ正常に使用できます。
  2. authCodeexpiresIn で指定された時間後に自動的に期限切れになります。
  3. フロントエンドは authCode を使用して実際のトークンと交換する必要があります。authCode をトークンとして直接使用しないでください。

レスポンス


フィードバック

このページは役に立ちましたか?