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 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string url	Web PubSub 服務實例的 HTTP 或 HTTPS 端點。
hub	path	True	string	目標中樞名稱，其開頭應為字母字元，且只包含英數位元或底線。 Regex 模式: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	REST API 的版本。
clientType	query		WebPubSubClientType	用戶端的類型。 不區分大小寫。 如果未設定，則為 「Default」。 針對 Socket.IO 的 Web PubSub，僅支援預設值。 對於 Web PubSub，有效值為 'Default' 和 'MQTT'。
group	query		string[]	連接會在連接時加入的群組。
minutesToExpire	query		integer int32	產生的令牌到期時間。
role	query		string[]	具有所產生令牌之連線的角色。
userId	query		string	用戶標識碼。

回應

名稱	類型	Description
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

範例要求

HTTP

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

範例回覆

狀態碼:

200

{
  "token": "ABCDEFG.ABC.ABC"
}

定義

名稱	Description
ClientTokenResponse	包含用戶端令牌的回應物件
ErrorDetail	error 物件。
InnerError
WebPubSubClientType	用戶端的類型。 不區分大小寫。 如果未設定，則為 「Default」。 針對 Socket.IO 的 Web PubSub，僅支援預設值。 對於 Web PubSub，有效值為 'Default' 和 'MQTT'。

ClientTokenResponse

包含用戶端令牌的回應物件

名稱	類型	Description
token	string	要連線至服務的WebSocket用戶端令牌值

ErrorDetail

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	ErrorDetail[]	導致此錯誤之特定錯誤的詳細數據陣列。
inner	InnerError
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

InnerError

名稱	類型	Description
code	string	比包含的錯誤所提供更明確的錯誤碼。
inner	InnerError

WebPubSubClientType

用戶端的類型。 不區分大小寫。 如果未設定，則為 「Default」。 針對 Socket.IO 的 Web PubSub，僅支援預設值。 對於 Web PubSub，有效值為 'Default' 和 'MQTT'。

名稱	類型	Description
Default	string
MQTT	string