Web Pub Sub - Generate Client Token

Služba:

Azure Web PubSub Service

Verze rozhraní API:

2024-01-01

Vygenerujte token pro klienta pro připojení služby Azure Web PubSub.

POST {endpoint}/api/hubs/{hub}/:generateToken?api-version=2024-01-01

S volitelnými parametry:

POST {endpoint}/api/hubs/{hub}/:generateToken?userId={userId}&role={role}&minutesToExpire={minutesToExpire}&api-version=2024-01-01&group={group}&clientType={clientType}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string url	Koncový bod HTTP nebo HTTPS pro instanci služby Web PubSub.
hub	path	True	string	Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko. Vzor regulárního výrazu: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	Verze rozhraní REST API.
clientType	query		WebPubSubClientType	Typ klienta. Nerozlišují se malá a velká písmena. Pokud není nastavená, je to Výchozí. Pro web PubSub pro Socket.IO se podporuje pouze výchozí hodnota. Pro Web PubSub jsou platné hodnoty Default a MQTT.
group	query		string[]	Skupiny, ke kterým se připojení připojí, když se připojí.
minutesToExpire	query		integer int32	Doba vypršení platnosti vygenerovaného tokenu.
role	query		string[]	Role, které bude mít připojení ke vygenerovanému tokenu.
userId	query		string	ID uživatele.

Odpovědi

Name	Typ	Description
200 OK	ClientTokenResponse	Úspěch Media Types: "text/plain", "application/json", "text/json"
Other Status Codes	ErrorDetail	Chybová odpověď Media Types: "text/plain", "application/json", "text/json" Hlavičky x-ms-error-code: string

Příklady

WebPubSub_GenerateClientToken

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
ClientTokenResponse	Objekt odpovědi obsahující token pro klienta
ErrorDetail	Objekt chyby.
InnerError
WebPubSubClientType	Typ klienta. Nerozlišují se malá a velká písmena. Pokud není nastavená, je to Výchozí. Pro web PubSub pro Socket.IO se podporuje pouze výchozí hodnota. Pro Web PubSub jsou platné hodnoty Default a MQTT.

ClientTokenResponse

Objekt odpovědi obsahující token pro klienta

Name	Typ	Description
token	string	Hodnota tokenu pro klienta WebSocket pro připojení ke službě

ErrorDetail

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	ErrorDetail[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
inner	InnerError
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

InnerError

Name	Typ	Description
code	string	Konkrétnější kód chyby, než poskytla chyba obsahující chybu.
inner	InnerError

WebPubSubClientType

Typ klienta. Nerozlišují se malá a velká písmena. Pokud není nastavená, je to Výchozí. Pro web PubSub pro Socket.IO se podporuje pouze výchozí hodnota. Pro Web PubSub jsou platné hodnoty Default a MQTT.

Name	Typ	Description
Default	string
MQTT	string