Web Pub Sub - Generate Client Token

서비스:

Azure Web PubSub Service

API 버전:

2024-01-01

클라이언트가 Azure Web PubSub 서비스를 연결하기 위한 토큰을 생성합니다.

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

선택적 매개 변수:

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string url	Web PubSub 서비스 인스턴스에 대한 HTTP 또는 HTTPS 엔드포인트입니다.
hub	path	True	string	대상 허브 이름- 알파벳 문자로 시작하고 영숫자 또는 밑줄만 포함해야 합니다. regex 패턴: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version	query	True	string	REST API의 버전입니다.
clientType	query		WebPubSubClientType	클라이언트의 형식입니다. 대/소문자를 구분하지 않습니다. 설정하지 않으면 "기본값"입니다. Socket.IO Web PubSub의 경우 기본값만 지원됩니다. Web PubSub의 경우 유효한 값은 'Default' 및 'MQTT'입니다.
group	query		string[]	연결될 때 연결이 조인할 그룹입니다.
minutesToExpire	query		integer int32	생성된 토큰의 만료 시간입니다.
role	query		string[]	생성된 토큰과의 연결에 있을 역할입니다.
userId	query		string	사용자 ID입니다.

응답

Name	형식	Description
200 OK	ClientTokenResponse	성공 Media Types: "text/plain", "application/json", "text/json"
Other Status Codes	ErrorDetail	오류 응답 Media Types: "text/plain", "application/json", "text/json" 헤더 x-ms-error-code: string

예제

WebPubSub_GenerateClientToken

샘플 요청

HTTP

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

샘플 응답

상태 코드:

200

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

정의

Name	Description
ClientTokenResponse	클라이언트에 대한 토큰을 포함하는 응답 개체
ErrorDetail	오류 개체입니다.
InnerError
WebPubSubClientType	클라이언트의 형식입니다. 대/소문자를 구분하지 않습니다. 설정하지 않으면 "기본값"입니다. Socket.IO Web PubSub의 경우 기본값만 지원됩니다. Web PubSub의 경우 유효한 값은 'Default' 및 'MQTT'입니다.

ClientTokenResponse

클라이언트에 대한 토큰을 포함하는 응답 개체

Name	형식	Description
token	string	서비스에 연결할 WebSocket 클라이언트의 토큰 값입니다.

ErrorDetail

오류 개체입니다.

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	ErrorDetail[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
inner	InnerError
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

InnerError

Name	형식	Description
code	string	포함된 오류에서 제공한 것보다 더 구체적인 오류 코드입니다.
inner	InnerError

WebPubSubClientType

클라이언트의 형식입니다. 대/소문자를 구분하지 않습니다. 설정하지 않으면 "기본값"입니다. Socket.IO Web PubSub의 경우 기본값만 지원됩니다. Web PubSub의 경우 유효한 값은 'Default' 및 'MQTT'입니다.

Name	형식	Description
Default	string
MQTT	string