Sign In Polling

Overview

When making a sign in request a poll token will be provided. Use this poll token on this request to monitor the status of the sign in request.

The response property success will always be true until the user completes the sign in with the provider. If the user takes longer than 5 minutes, the request will return an error saying the token has now expired.

If a user completes a sign in with the provider within 5 minutes, there are two outcomes:

• signInFailed returns as true along with a signInErrorMessage indicating the sign in failed. Typically this is because the user chose not to complete the sign in with the login provider, or they entered invalid credentials. This response is only returned once, after which repeat calls with the poll token will show an invalid poll token error. Not all login providers will return an error, in which case the token will eventually expire if the user abandons or cancels the login.
• The property session will return a new session object, indicating that the sign in succeeded. This response is only returned once, after which repeat calls with the poll token will show an invalid poll token error.

Request URL

All parameters in the request must be sent as a POST HTTP request. Make all requests to the following URL:

https://auth.construct.net/signinpoll.json

{
  "success": true,
  "session": { ... },
  "signInErrorMessage": "The user cancelled the sign in request.",
  "signInFailed": true,
  "formattingCulture": "en-us"
}

{
  "success": false,
  "errorMessage": "Your request failed due to...",
  "helpURL": "https://www.construct.net/en/game-services/manuals/game-services/authentication/api-end-points/players/sign-in-poll",
  "shouldRetry": false
}