Web Pub Sub - Generate Client Token

Service:

Azure Web PubSub Service

API Version:

2023-07-01

Genere el token para que el cliente conecte el servicio Azure Web PubSub.

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

With optional parameters:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string url	Punto de conexión HTTP o HTTPS para la instancia del servicio Web PubSub.
hub	path	True	string	El nombre del centro de destino, que debe comenzar con los caracteres alfabéticos y solo puede contener caracteres alfanuméricos o un guion bajo. Regex pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	La versión de las API REST.
group	query		string[]	Grupos a los que se unirá la conexión cuando se conecte.
minutesToExpire	query		integer int32	La hora de expiración del token generado.
role	query		string[]	Roles que tendrá la conexión con el token generado.
userId	query		string	Id. de usuario.

Respuestas

Nombre	Tipo	Description
200 OK	ClientTokenResponse	Correcto Media Types: "text/plain", "application/json", "text/json"
Other Status Codes	ErrorDetail	Respuesta de error Media Types: "text/plain", "application/json", "text/json" Headers x-ms-error-code: string

Ejemplos

WebPubSub_GenerateClientToken

Sample Request

HTTP

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

Sample Response

Status code:

200

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

Definiciones

Nombre	Description
ClientTokenResponse	Objeto de respuesta que contiene el token para el cliente.
ErrorDetail	Objeto de error.
InnerError

ClientTokenResponse

Objeto de respuesta que contiene el token para el cliente.

Nombre	Tipo	Description
token	string	El valor de token del cliente webSocket para conectarse al servicio

ErrorDetail

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de los conjuntos de códigos de error definidos por el servidor.
details	ErrorDetail[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
inner	InnerError
message	string	Representación legible del error.
target	string	Destino del error.

InnerError

Nombre	Tipo	Description
code	string	Código de error más específico del proporcionado por el error contenedor.
inner	InnerError