コンテンツにスキップ

IdP リスト照会

アプリ クライアントからログインに成功した後に返されるプレーヤー ID とアプリ ID を使用して、プレーヤーにリンクされている IdP (アイデンティティ プロバイダー) のリストをアプリ サーバーから取得します。 「Get IdP list」API はサーバー間通信を通じて動作し、アプリサーバーは Hive 認証サーバーを直接呼び出します。リクエストが成功すると、リンクされた IdP 情報が応答のデータ フィールドに配列として返されます。 リクエストを行う場合、App ID と Player ID は必須パラメータです。

リクエスト URL

本番URL https://auth.qpyou.cn/v2/game/player/get-idp
分散環境の URL https://auth.globalwithhive.com/v2/game/player/get-idp
サンドボックス URL https://sandbox-auth.qpyou.cn/v2/game/player/get-idp
HTTP メソッド POST
Content-Type application/json
データ形式 JSON
Note

Hive 認証サーバーは、障害や不安定なネットワーク通信に備えて分散環境で構成されています。
認証サーバーホストとの通信中に障害が発生した場合、またはアプリサーバーで定義されたタイムアウトを超えた場合、アプリサーバーは分散環境の URL (フォールバック URL) を直接呼び出す必要があります。


リクエストヘッダー

フィールド名 説明 タイプ 必須
X-Access-Token ゲームサーバー認証用の OAuth 2.0 アクセス トークン
(OAuth トークン発行 を参照)
String Y
ISCRYPT データが暗号化されているかどうか (0 = 暗号化されていない、常に 0 を渡します) Integer Y

## リクエスト本文
フィールド名 説明 タイプ 必須
--- --- --- ---
appid アプリID String Y
player_id ログイン成功後に返される認証プレーヤー ID BigInteger Y


リクエストの例

{
    "appid": "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal",
    "player_id": 90000000062
}


レスポンスボディ

フィールド名 説明 タイプ
result_code レスポンスコード 詳細 Integer
result_msg 結果メッセージ String
token_validation JWT検証結果(JWT 検証エラー) Object
token_validation.result_code JWT検証結果コード Integer
token_validation.result_msg JWT検証結果メッセージ String
data IdP リスト データ Array
data[].seq ユーザー主キー (PK) BigInteger
data[].player_id プレイヤーID BigInteger
data[].idp_user_id IdP によって提供されるユーザー ID 値 String
data[].idp_index IdP 固有番号 詳細 Integer
data[].idp_id IdP の文字列値 String

結果コード

コード値 説明
0 成功
2002 ユーザーデータがありません
4000 無効なパラメータ
2499 JWT 検証が失敗しました (token_validation を参照)。

## 応答例
### 成功
{
    "result_code": 0,
    "result_msg": "SUCCESS",
    "token_validation": {
        "result_code": 0,
        "result_msg": "success"
    },
    "data": [
        {
            "seq": 10000000067,
            "player_id": 90000000062,
            "idp_user_id": "0",
            "idp_index": 0,
            "idp_id": "GUEST"
        },
        {
            "seq": 10000000068,
            "player_id": 90000000062,
            "idp_user_id": "64646595",
            "idp_index": 1,
            "idp_id": "HIVE"
        }
    ]
}

JWT 検証の失敗

{
    "result_code": 2499,
    "result_msg": "JWT validation failed. See token_validation for details.",
    "token_validation": {
        "result_code": 2408,
        "result_msg": "The access token is expired. Please refresh your token."
    }
}
Note

JWT 検証が失敗した場合は、token_validation フィールドで詳細なエラー情報を確認できます。詳細については、JWT 検証エラーコードを参照してください。

IdP インデックス

IdP インデックス情報については、IdP リスト を参照してください。