STOVE supports OpenID, below guideline explains how you can fetch OpenID information from STOVE.
- This API is written based on the OpenID Connect 1.0 UserInfo Endpoint
- User Information is fetched using Access Token
[For Games using Epic Online Services(EOS)]
- In order to use OpenID as Identity Provider, you need to directly contact EOS Customer Support.
- Go to below link, and use the format below and send an application to activate OpenID
- (For PRODUCT_ID, DESCRIPTION use those your own. )
EOS Customer Center: https://eoshelp.epicgames.com/s/private-question-page?language=en_US
[Format]
I would like to use OpenID as an identity provider for my product.
The OpenID specification is the following:
Product ID: {PRODUCT_ID}
Description: {DESCRIPTION}
Type: UserInfo Endpoint
UserInfo API Endpoint: https://api.onstove.com/oidc/v1/userinfo
HTTP Method: GET
Name of the AccountId field: "sub"
Name of the DisplayName field: "nickname"
API Information
GET /v1/userinfo
Host:
https://api.onstove.com/oidc (LIVE)
JavaScript
복사
Request
Header
Name | Type | Required | Default Value | Value | Description |
Authorization | String | Y | - | Bearer {user_access_token} | User’s Access Token |
Response
Body
Success
Name | Type | Required | Default Value | Example | Description |
sub | String | Y | - | "20005061986" | STOVE user’s GUID
(unique user number) |
nickname | String | N | - | "STOVE20005061986" | User name (in platform) |
Failure
Name | Type | Required | Default Value | Example | Description |
code | Integer | N | - | 40101 | |
message | String | N | - | invalid token | 응답 메시지 |
Sample
Request
curl --location --request GET 'https://api-dev.onstove.com/oidc/v1/userinfo' \--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHBpcmVfdGltZSI6MTcxMTQzNTA2OTcyNiwibWVtYmVyX25vIjoxMDAwMDAwMDIzMjEsImFwcGxpY2F0aW9uX25vIjoxMDAwMn0.llanAiKn7TD1Z__coIGYtM_8HYc4UShNHWPYdhzyZ-B6hPPCAIiKGtwZrZyZk56EcwwzKDpCOLdzYT1wMYuBOG7L51Y29JeVjinjVCa2W-DPiumex3mo6B-wlVo_Y0SMrd2mDIsq3TQ-TlnEufFv_RnZtZ6SzYpXGmD0NyK0rvKwrp9PiEL5Rbd1jvoqyN1H2FNnne54miP5JnVUoorvLkazQQKY1bWKm91wX89oKPwlmLGQnnf_K-amylchCirM9Sl1tLOwgJamymJVUH_OPXQX9sAJzanTGfehIulEF8o'
JavaScript
복사
Response
Success
Content-Type : application/json
HTTP/ 1.1 200 OK
{
"sub": "200000000792",
"nickname": "STOVE175229625958212"
}
JSON
복사
Failure
Content-Type : application/json
// When User Access Token is invalid
HTTP/1.1 401 Unauthorized
{
"message": "invalid token",
"code": 40101
}
// When User Access Token is expired
HTTP/1.1 401 Unauthorized
{
"code": 40103,
"message": "expired token"
}
JSON
복사
Return Code
HTTP Status code | Code | Message | Description |
200 | Success | ||
401 | 40101 | invalid token | Access Token is invalid
• Check Authorization Header
• Check whether the correct token is used. |
401 | 40103 | expired token | Access Token is expired
• Authorization Header is using an expired token |