Xbox Live

POST 
/external/xboxauth

Request an access token on behalf of an Xbox Live user. To use this endpoint you will need to setup some additional settings prior to being able to authenticate Xbox Live users. Head here for these instructions. A Successful request will return an Access Token Object.

HINT: If you want to overlay the mod.io site in-game on Xbox, we recommend you add ?portal=xboxlive to the end of the URL you open which will prompt the user to login with Xbox Live. See Web Overlay Authentication for details.

Request

Error Codes

Status Code	Error Ref	Description
401	11027	The Xbox Live token supplied in the request is invalid.
401	11029	The Xbox Live token supplied has expired.
401	11032	mod.io was unable to verify the credentials against the external service provider.
401	14001	The game associated with the supplied api_key is currently not available.
403	11016	The api_key supplied in the request must be associated with a game.
403	11017	The api_key supplied in the request is for test environment purposes only and cannot be used for this functionality.
403	11028	The user is not permitted to interact with UGC. This can be modified in the user's Xbox Live profile.
403	11030	Xbox Live users with 'Child' accounts are not permitted to use mod.io.
403	11074	The user has not agreed to the mod.io Terms of Use. Please see terms_agreed parameter description and the Terms endpoint for more information.
403	11133	The user account for XboxLive already exists, please login by email and connect your XboxLive account to your modio account instead.

See here for more details about errors.

Responses

200

Successful Request

401

The game associated with the supplied api_key is currently not available.

403

The api_key supplied in the request must be associated with a game.