Version 2021
Check whether a user has logged in
Checks whether a user has already logged in by scanning a QR code, as part of the Badge QR code OAuth login workflow.
Request format
HTTP method
GET
HTTP header
The cookie indicating the Badge single sign-on (SSO) session. This cookie is obtained in the create_session
API call (see Create a single sign-on (SSO) session).
Resource URL
/sso/wait?session_type=session_type&client_id=client_id&return_token=return_token
Parameters
Parameter | Required? | Description |
---|---|---|
session_type
|
Required | Specify the session_type as nonblock for Identity Server to return information even when the server is not ready. |
client_id
|
Required | The Badge Application ID associated with this mobile app. This value is provided in Identity Manager when you register the third-party mobile app. |
return_token
|
Optional | Whether to return a user's identity token. This token allows you to make additional queries to Identity Server to return information about the user, and to do things on behalf of a user. By default, a token is not returned. Enter 1 to return a token.
|
Response format
Response body
{ "status": "...", "badge_id": "...""access_token": "..."}
Example
Example request
curl -i "https://uvs-v2.usher.com/sso/wait?session_type=nonblock&client_id=26&return_token=1" -H "Cookie: SSO_SESSION=queIh8Y-ghFI9A5BsQs3FloSWMR2hkj4kcY5dfoai_CFTKI3Ni1_Z10ukh_h5hkSj4g
Example response
{"status":"success","badge_id":"1984","access_token":"YkoYxL89KcFzT2GyxgYwehDj6IjJw28S64s4U_xCPwHhxk-DQC9pKVy6zMLFW1VLg5E"}