Service Account Key を、管理者を主体とする短期アクセストークンに交換します。
POST /api/v1/forward/service_account_tokens
Service Account Token は、エンタープライズ連携で Forward API を呼び出すための短期認証情報です。エンタープライズの Service Account Key でこの API を呼び出し、管理者を主体とする Token を取得します。その後、業務リクエストの Authorization ヘッダーに Bearer Token として指定すると、Templates、Identities、Sessions などの管理 API にアクセスできます。
特定のエンドユーザー（Identity）としてセッション API にアクセスする場合は、Identity 用 Service Account Token の作成を使用してください。
リクエストヘッダー
| Header | 必須 | 説明 |
|---|---|---|
| Authorization | はい | Bearer <Service Account Key> |
| Content-Type | はい | application/json |
リクエストボディ
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
| ttl_seconds | integer | いいえ | Token の有効期間（秒）。1～43200（最大 12 時間）。省略時はプラットフォームのデフォルト値が使用されます。 |
| metadata | object | いいえ | 監査用に Token の用途を示すビジネスメタデータ。 |
リクエスト例
レスポンス例
HTTP 201 Created
レスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
| type | string | 常に service_account_token。 |
| access_token | string | 短期アクセストークン。このレスポンスでのみ返されるため、安全に保管してください。 |
| token_type | string | 常に Bearer。 |
| expires_in | integer | 有効期間（秒）。 |
| expires_at | string | RFC 3339 形式の有効期限。 |
| auth_token_id | string | Token を失効させる際に使用する一意の ID。 |
| service_account_id | string | Token を発行した Service Account の ID。 |
| credential_id | string | Token を発行した Service Account Key の ID。 |
| subject_type | string | Token の主体タイプ。この API では admin。 |
エラー
| HTTP | Type | Code | 条件 |
|---|---|---|---|
| 400 | invalid_request_error | - | リクエストボディが無効、または ttl_seconds が 1～43200 の範囲外。 |
| 401 | authentication_error | - | Service Account Key が無効または期限切れ、あるいは別の種類の認証情報を使用。 |
| 503 | api_error | - | Token 発行サービスが一時的に利用不可。後でもう一度お試しください。 |
注意事項
- Service Account Key は、Qoder コンソールのエンタープライズ認証情報ページで作成および管理します。エンタープライズ組織でのみ利用できます。
- Token は期限切れになると自動的に無効になり、更新できません。期限切れになる前に新しい Token を取得してください。
- Service Account Key を業務 API に直接使用しないでください。業務 API が受け付けるのは PAT または Service Account Token のみです。