Web Pub Sub - Generate Client Token

Service:

Azure Web PubSub Service

API Version:

2023-07-01

Generowanie tokenu dla klienta w celu połączenia usługi 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}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string url	Punkt końcowy HTTP lub HTTPS dla wystąpienia usługi Web PubSub.
hub	path	True	string	Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. Regex pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	Wersja interfejsów API REST.
group	query		string[]	Grupy, które połączenie zostanie przyłączone po nawiązaniu połączenia.
minutesToExpire	query		integer int32	Czas wygaśnięcia wygenerowanego tokenu.
role	query		string[]	Role, które będą mieć połączenie z wygenerowany token.
userId	query		string	Identyfikator użytkownika.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ClientTokenResponse	Powodzenie Media Types: "text/plain", "application/json", "text/json"
Other Status Codes	ErrorDetail	Odpowiedź na błąd Media Types: "text/plain", "application/json", "text/json" Headers x-ms-error-code: string

Przykłady

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"
}

Definicje

Nazwa	Opis
ClientTokenResponse	Obiekt odpowiedzi zawierający token dla klienta
ErrorDetail	Obiekt error.
InnerError

ClientTokenResponse

Obiekt odpowiedzi zawierający token dla klienta

Nazwa	Typ	Opis
token	string	Wartość tokenu dla klienta protokołu WebSocket w celu nawiązania połączenia z usługą

ErrorDetail

Obiekt error.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	ErrorDetail[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
inner	InnerError
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

InnerError

Nazwa	Typ	Opis
code	string	Bardziej szczegółowy kod błędu niż został dostarczony przez błąd zawierający.
inner	InnerError