トークンの生成(旧API、2026-05-31に廃止予定)¶
POST /api/v1/offline_token/temporary_token/create
概要¶
アクセストークンを生成します。
廃止に関する説明:
この旧APIは 2026-05-31 に廃止予定です。POST /offline_token/temporary_auth_code/create への早期の移行を推奨します。
使用方法:
- ページURLにパラメータを追加:
gc_route_token=xxxx。クロスドメインのiframeネストの場合は、サードパーティCookieのブロックによるクロスドメイン問題が発生する可能性があります。 - ページ遷移が不要な場合。ページURLにパラメータを追加:
ftAuthToken=xxx。
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| roles | array | ロールリストのUUID 例: ['readOnly'] 空を許可: False |
|
| roles[*] | string | Y | ロール識別子 空を許可: False |
| expires | integer | Y | トークンの有効期限(単位: 秒) 例: 3600 空を許可: False $maxValue: 604800 $minValue: 1 |
パラメータ補足説明¶
廃止に関する説明
このAPIは旧来のものです。2026-05-31 に廃止予定です。
POST /offline_token/temporary_auth_code/create への移行を推奨します。まずは使い捨ての authCode を取得し、その後フロントエンドの認証交換APIを介して実際のトークンと交換してください。
パラメータ説明
- サポートされるロールリスト
| ロール | 説明 |
|---|---|
| wsAdmin | 管理者ロール |
| general | 標準メンバーロール |
| readOnly | 読み取り専用ロール |
| role_xxx | カスタムロールのUUID |