認証コードの生成¶
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 のみを返します。
認証情報をページパラメータでフロントエンドに渡す必要があるが、実際のトークンを直接公開したくない場合に適しています。
- 認証不要の中間ページのURL
/redirect_auth/{authCode}?overwrite=true&to=xxxを組み立てます。中間ページは authCode を実際のトークンと交換します。 - パラメータ overwrite=true は、現在ログイン中のトークンを上書きすることを示します(デフォルトでは省略可能で、一時トークンとして扱われます)。
- パラメータ to=xxx は、遷移先のページアドレス(相対アドレス)を示します。
- 交換が成功すると
authCodeは直ちに無効になります。引き続き使用する必要がない場合は、POST /offline_token/temporary_auth_code/revokeを呼び出して明示的に無効にできます。
注意事項
authCodeは1回のみ正常に使用できます。authCodeはexpiresInで指定された時間後に自動的に期限切れになります。- フロントエンドは
authCodeを使用して実際のトークンと交換する必要があります。authCodeをトークンとして直接使用しないでください。