OpenID
POST/external/openidauth
Request an access token on behalf of an OpenID identity provider. To use this method of authentication, you must configure the OpenID config in your game's authentication admin page. A Successful request will return an Access Token Object.
NOTE: The ability to authenticate players using your identity provider is a premium feature. If you are interested in accessing premium features via your games dashboard, please [contact us](mailto:developers@mod.io?subject=OpenID SSO Request).
HINT: If you want to overlay the mod.io site in-game, we recommend you add ?portal=studio to the end of the URL you open which will prompt the user to login with your auth provider if they are on your games page. See Web Overlay Authentication for details.
Request
Error Codes
| Status Code | Error Ref | Description |
|---|---|---|
| 401 | 11032 | mod.io was unable to verify the credentials against the external service provider. |
| 401 | 11091 | The audience configured in the OpenID config does not match the audience in the ID token. |
| 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 | 11074 | The user has not agreed to the mod.io Terms of Use. Please see terms_agreed parameter description and the [Terms](/restapi/docs/terms) endpoint for more information. |
| 403 | 11086 | You must configure your OpenID config for your game in your game authentication settings before being able to authenticate users. |
| 403 | 17053 | The user account associated with this email is locked. Please contact support for assistance. |
Responses
- 200
- 401
- 403
Successful Request
The game associated with the supplied api_key is currently not available.
The api_key supplied in the request must be associated with a game.