Web Pub Sub - Generate Client Token

Serviço:

Azure Web PubSub Service

Versão da API:

2024-01-01

Gere token para o cliente conectar o serviço Azure Web PubSub.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string url	Ponto de extremidade HTTP ou HTTPS para a instância do serviço Web PubSub.
hub	path	True	string	Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado. Padrão Regex: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	A versão das APIs REST.
clientType	query		WebPubSubClientType	O tipo de cliente. Não diferencia maiúsculas de minúsculas. Se não estiver definido, é "Padrão". Para Web PubSub para Socket.IO, apenas o valor padrão é suportado. Para Web PubSub, os valores válidos são 'Default' e 'MQTT'.
group	query		string[]	Grupos aos quais a conexão ingressará quando se conectar.
minutesToExpire	query		integer int32	O tempo de expiração do token gerado.
role	query		string[]	Funções que a conexão com o token gerado terá.
userId	query		string	ID do usuário.

Respostas

Name	Tipo	Description
200 OK	ClientTokenResponse	Sucesso Media Types: "text/plain", "application/json", "text/json"
Other Status Codes	ErrorDetail	Resposta de erro Media Types: "text/plain", "application/json", "text/json" Cabeçalhos x-ms-error-code: string

Exemplos

WebPubSub_GenerateClientToken

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

200

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

Definições

Name	Description
ClientTokenResponse	O objeto de resposta que contém o token para o cliente
ErrorDetail	O objeto de erro.
InnerError
WebPubSubClientType	O tipo de cliente. Não diferencia maiúsculas de minúsculas. Se não estiver definido, é "Padrão". Para Web PubSub para Socket.IO, apenas o valor padrão é suportado. Para Web PubSub, os valores válidos são 'Default' e 'MQTT'.

ClientTokenResponse

O objeto de resposta que contém o token para o cliente

Name	Tipo	Description
token	string	O valor do token para o cliente WebSocket se conectar ao serviço

ErrorDetail

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	ErrorDetail[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
inner	InnerError
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

InnerError

Name	Tipo	Description
code	string	Um código de erro mais específico do que foi fornecido pelo erro que contém.
inner	InnerError

WebPubSubClientType

O tipo de cliente. Não diferencia maiúsculas de minúsculas. Se não estiver definido, é "Padrão". Para Web PubSub para Socket.IO, apenas o valor padrão é suportado. Para Web PubSub, os valores válidos são 'Default' e 'MQTT'.

Name	Tipo	Description
Default	string
MQTT	string