Web Pub Sub - Generate Client Token

Service:

Azure Web PubSub Service

Version d'API:

2024-01-01

Générez un jeton pour que le client connecte le service Azure Web PubSub.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string url	Point de terminaison HTTP ou HTTPS pour l’instance de service Web PubSub.
hub	path	True	string	Nom du hub cible, qui doit commencer par des caractères alphabétiques et ne contient que des caractères alphanumériques ou un trait de soulignement. Modèle d’expression régulière: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	Version des API REST.
clientType	query		WebPubSubClientType	Type de client. Respect de la casse. S’il n’est pas défini, il s’agit de « Default ». Pour Web PubSub pour Socket.IO, seule la valeur par défaut est prise en charge. Pour Web PubSub, les valeurs valides sont « Default » et « MQTT ».
group	query		string[]	Groupes auxquels la connexion se joint lorsqu’elle se connecte.
minutesToExpire	query		integer int32	Heure d’expiration du jeton généré.
role	query		string[]	Rôles que la connexion avec le jeton généré aura.
userId	query		string	Identifiant.

Réponses

Nom	Type	Description
200 OK	ClientTokenResponse	Succès Media Types: "text/plain", "application/json", "text/json"
Other Status Codes	ErrorDetail	Réponse d’erreur Media Types: "text/plain", "application/json", "text/json" En-têtes x-ms-error-code: string

Exemples

WebPubSub_GenerateClientToken

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

200

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

Définitions

Nom	Description
ClientTokenResponse	Objet de réponse contenant le jeton pour le client
ErrorDetail	Objet d’erreur.
InnerError
WebPubSubClientType	Type de client. Respect de la casse. S’il n’est pas défini, il s’agit de « Default ». Pour Web PubSub pour Socket.IO, seule la valeur par défaut est prise en charge. Pour Web PubSub, les valeurs valides sont « Default » et « MQTT ».

ClientTokenResponse

Objet de réponse contenant le jeton pour le client

Nom	Type	Description
token	string	Valeur du jeton pour le client WebSocket à connecter au service

ErrorDetail

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	ErrorDetail[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
inner	InnerError
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

InnerError

Nom	Type	Description
code	string	Code d’erreur plus spécifique que fourni par l’erreur contenante.
inner	InnerError

WebPubSubClientType

Type de client. Respect de la casse. S’il n’est pas défini, il s’agit de « Default ». Pour Web PubSub pour Socket.IO, seule la valeur par défaut est prise en charge. Pour Web PubSub, les valeurs valides sont « Default » et « MQTT ».

Nom	Type	Description
Default	string
MQTT	string