Dela via

Web Pub Sub - Generate Client Token

Tjänst:
Azure Web PubSub Service
API-version:
2024-01-01

Generera token för klienten för att ansluta Azure Web PubSub-tjänsten.

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

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
 path True

string (url)

HTTP- eller HTTPS-slutpunkt för web pubsub-tjänstinstansen.
hub
 path True

string

pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$

Målhubbens namn, som ska börja med alfabetiska tecken och endast innehålla alfanumeriska tecken eller understreck.
api-version
 query True

string

Versionen av REST-API:erna.
clientType
 query

WebPubSubClientType

Typen av klient. Skiftlägesokänsligt. Om det inte anges är det "Standard". För Web PubSub för Socket.IO stöds endast standardvärdet. För Web PubSub är de giltiga värdena "Standard" och "MQTT".
group
 query

string[]

Grupper som anslutningen ansluter till när den ansluter.
minutesToExpire
 query

integer (int32)

minimum: 1

Förfallotiden för den genererade token.
role
 query

string[]

Roller som anslutningen till den genererade token kommer att ha.
userId
 query

string

Användar-ID.

Svar

Name Typ Description
200 OK

ClientTokenResponse

Framgång

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

ErrorDetail

Felsvar

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

Sidhuvuden

x-ms-error-code: string

Exempel

WebPubSub_GenerateClientToken

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
ClientTokenResponse

Svarsobjektet som innehåller token för klienten
ErrorDetail

Felobjektet.
InnerError
WebPubSubClientType

Typen av klient. Skiftlägesokänsligt. Om det inte anges är det "Standard". För Web PubSub för Socket.IO stöds endast standardvärdet. För Web PubSub är de giltiga värdena "Standard" och "MQTT".

ClientTokenResponse

Objekt

Svarsobjektet som innehåller token för klienten

Name Typ Description
token

string

Tokenvärdet för WebSocket-klienten för att ansluta till tjänsten

ErrorDetail

Objekt

Felobjektet.

Name Typ Description
code

string

En av en serverdefinierad uppsättning felkoder.
details

ErrorDetail[]

En matris med information om specifika fel som ledde till det rapporterade felet.
inner

InnerError

message

string

En mänsklig läsbar representation av felet.
target

string

Målet för felet.

InnerError

Objekt
Name Typ Description
code

string

En mer specifik felkod än vad som angavs av det innehållande felet.
inner

InnerError

WebPubSubClientType

Uppräkning

Typen av klient. Skiftlägesokänsligt. Om det inte anges är det "Standard". För Web PubSub för Socket.IO stöds endast standardvärdet. För Web PubSub är de giltiga värdena "Standard" och "MQTT".

Värde Description
Default
MQTT