Web Pub Sub - Generate Client Token

  • リファレンス
サービス:
Azure Web PubSub Service
API バージョン:
2024-01-01

クライアントが Azure Web PubSub サービスに接続するためのトークンを生成します。

POST {endpoint}/api/hubs/{hub}/:generateToken?api-version=2024-01-01
省略可能なパラメーターを含む: 
POST {endpoint}/api/hubs/{hub}/:generateToken?userId={userId}&role={role}&minutesToExpire={minutesToExpire}&api-version=2024-01-01&group={group}&clientType={clientType}

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

url

Web PubSub サービス インスタンスの HTTP または HTTPS エンドポイント。
hub
 path True

string

ターゲット ハブ名。アルファベット文字で始まり、英数字またはアンダースコアのみを含む必要があります。

正規表現パターン: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version
 query True

string

REST API のバージョン。
clientType
 query

WebPubSubClientType

クライアントの種類。 大文字と小文字は区別されません。 設定されていない場合は、"既定" になります。 Socket.IO の Web PubSub では、既定値のみがサポートされます。 Web PubSub の場合、有効な値は 'Default' と 'MQTT' です。
group
 query

string[]

接続時に接続が参加するグループ。
minutesToExpire
 query

integer

int32

生成されたトークンの有効期限。
role
 query

string[]

生成されたトークンとの接続に含まれるロール。
userId
 query

string

ユーザー ID。

応答

名前 型 説明
200 OK

ClientTokenResponse

成功

Media Types: "text/plain", "application/json", "text/json"
Other Status Codes

ErrorDetail

エラー応答

Media Types: "text/plain", "application/json", "text/json"

ヘッダー

x-ms-error-code: string

例

WebPubSub_GenerateClientToken

要求のサンプル

POST {endpoint}/api/hubs/hub1/:generateToken?userId=user1&minutesToExpire=5&api-version=2024-01-01&clientType=MQTT

応答のサンプル

状態コード:
200 
{
  "token": "ABCDEFG.ABC.ABC"
}

定義

名前 説明
ClientTokenResponse

クライアントのトークンを含む応答オブジェクト
ErrorDetail

エラー オブジェクト。
InnerError
WebPubSubClientType

クライアントの種類。 大文字と小文字は区別されません。 設定されていない場合は、"既定" になります。 Socket.IO の Web PubSub では、既定値のみがサポートされます。 Web PubSub の場合、有効な値は 'Default' と 'MQTT' です。

ClientTokenResponse

クライアントのトークンを含む応答オブジェクト

名前 型 説明
token

string

サービスに接続する WebSocket クライアントのトークン値

ErrorDetail

エラー オブジェクト。

名前 型 説明
code

string

サーバー定義の一連のエラー コードの 1 つ。
details

ErrorDetail[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
inner

InnerError

message

string

エラーの人間が判読できる表現。
target

string

エラーのターゲット。

InnerError

名前 型 説明
code

string

含まれているエラーによって提供されたよりも具体的なエラー コード。
inner

InnerError

WebPubSubClientType

クライアントの種類。 大文字と小文字は区別されません。 設定されていない場合は、"既定" になります。 Socket.IO の Web PubSub では、既定値のみがサポートされます。 Web PubSub の場合、有効な値は 'Default' と 'MQTT' です。

名前 型 説明
Default

string

MQTT

string