アクセストークンのペイロード
Understand the payload section of a Vivox Access Token.
読み終わるまでの所要時間 1 分最終更新 23日前
ペイロードは、トークンによってアサートされたクレームを含む、base64url エンコードされた JSON オブジェクトです。ペイロード内ではクレームを任意の順序でリストできます。 以下の表に、トークンで使用できるクレームを示します。各トークンで要求されるパラメーターの詳細については、アクセストークンの例 を参照してください。
ペイロード内の Unity Authentication ID
アプリケーションがプレイヤーを認証するために Unity Authentication サービスを使用している場合、適切なプレイヤー識別を保証するために Vivox アクセストークン内で UAS ID を使用できます。SIP URI 全体から確実にプレイヤー ID を解析するために、プレイヤーの識別に使用される SIP URI を正しい形式にする必要があります。Unity Moderation サービスを VAT で使用する場合にはこの形式が必須です。 必要な SIP 形式の例を以下に示します。UAS と一緒に作動するためにはsip:.issuer.unity_player_id.unity_environment_id.@domain.vivox.com
fsub注
例で示されているパラメーターのみを入れるようにしてください。クレームに誤ったパラメーターが入っていると、API 呼び出しで "invalid signature" または "malformed payload" エラーが返されます。
| クレームでサポートされる値 | 値の例 | 説明 |
| vxi | 1 | トークンの一意性を保証します。 他のクレームがすべて同一である場合は、このクレームが異なっている必要があります。そうでないと、トークンがすでに使用されているものとして拒否されることがあります。 生成されるすべてのトークンについて、1 ずつ増分する符号なし整数を使用することをお勧めします。 |
| sub | sip:.blindmelon-AppName-dev.jerky.@tla.vivox.com | サブジェクト。 ミュートアクションとキックアウトアクションに使用されるユーザーの SIP URI です。 これは、ミュート/ミュート解除またはキックアウトされるユーザーです。 |
| f | sip:.blindmelon-AppName-dev.beef.@tla.vivox.com | 発行元。 これは、すべてのアクションで使用されるユーザーの SIP URI です。 これは、サインイン、チャンネルへの参加、別のユーザーのミュートなどのアクションを実行するユーザーです。 |
| iss | blindmelon-AppName-dev | アプリケーション固有の発行者。 発行者は、Unity Dashboard でアプリケーションを作成するときに提供されます。 |
| vxa | kick | Vivox アクション。 詳細については、Vivox アクションクレームでサポートされる値 を参照してください。 |
| t | sip:confctl-g-blindmelon-AppName-dev.testchannel@tla.vivox.com | 発行先。 これは、参加、ミュート、キックアウト、トランスクリプションの各アクションで使用されるチャンネルの SIP URI です。 これは、アクションが実行されるチャンネルです。 |
| exp | 1600349400 | 有効期限 (エポック秒)。 通常、この値は現在時刻に 90 秒を加えたものです。 |