コンテンツにスキップ

リフレッシュトークン

トークン更新 は、発行されたリフレッシュトークン（user_info.refresh_token）を使用してアクセストークン/リフレッシュトークンを更新するAPIです。ログイン検証とユーザー情報取得のAPIリクエストを行った後に実行されます。

Note

アクセストークンは発行後1時間有効であり、期限切れ前または後にリフレッシュトークンを使用して更新できます。リフレッシュトークンの有効期限は30日です。

リクエスト URL

環境 URL
本番環境 https://weblogin.withhive.com/oauth/token
サンドボックス https://sandbox-weblogin.withhive.com/oauth/token
HTTPメソッド POST
コンテンツタイプ application/json

リクエストボディ

フィールド名 タイプ 説明 必須
grant_type 文字列 OAuth 2.0 認可コードフロー default: refresh_token Y
client_id 文字列 セキュリティキー設定で生成されたOAuth 2.0クライアントID。Hiveコンソールのアプリセンター > セキュリティキー設定で確認できます。 Y
client_secret 文字列 セキュリティキー設定で生成されたOAuth 2.0クライアントシークレット。Hiveコンソールのアプリセンター > セキュリティキー設定で確認できます。 Y
refresh_token 文字列 リフレッシュトークン Y

リクエストボディの例

{
  "grant_type": "refresh_token",
  "client_id": "58b48cd3-df47-5b52-2627-3f9c8d01",
  "client_secret": "bec7760b237244c4c818d6174587d8e1",
  "refresh_token": "eyJraWQiOiIwYThlMThkOS1hNmZiLTM3ZDMtNjkwYy02Zjg1ZTllNCIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc193aGl0ZWxpc3QiOmZhbHNlLCJwcm9qZWN0X2lkIjoiY29tLmNvbTJ1cy5oaXZlc2RrIiwiZ3JhbnRfdHlwZSI6InVzZXIiLCJ1c2VyX2lkIjoyMDAwMDAxODU1MiwidG9rZW5fdHlwZSI6InJlZnJlc2hfdG9rZW4iLCJleHAiOjE3NDgxNTAzODMsImlhdCI6MTc0NTU1ODM4MywiYXV0aF92ZXIiOiJ2NCJ9.fvXTfRDYhlk21EY-ngAXbQMgYM9f-rFYPBa_GMV3JDz3cy9wwGfPTnF-VO0WkpxzpPdbG1ZX0HAdIkT4kF873ee2d-g6-JeuIEy0SFcTMpdYWXnlOfsuZlFIkzCm0OB_mlnNo_wxXHvjHM_dFDF-SfK2r9_ga8yLOXDfLJeA4XUYGwwsG3XT9x5Vy8RlUcF2aeuf-2bXdLSD2NGssZh18RTayV2CNtGuX0kj-nABVVTzLWUqbwKSrIVXjlS76zxl3SisUW_pz97iM98yLLRdpe_56_VDPzKEqVmn4bCyhhlAT1LEdu_uudlBY7hSUX0cJzcLAtj_4GReuLU9SnvQpw"
}

レスポンスボディ

フィールド名 タイプ 説明 備考
code 整数 ウェブログインレスポンスコード
access_token 文字列 アクセストークン 有効期限: 1時間
refresh_token 文字列 リフレッシュトークン 有効期限: 30日

ウェブログインレスポンスコード

コード 説明 備考
100 成功
1050 無効なパラメータ
2011 プロジェクト情報なし
2013 プロジェクトは終了状態です
7001 OAuth2.0クライアントID値なし Hiveコンソールで確認 アプリセンター > セキュリティキー設定
7002 OAuth2.0クライアント情報の不一致 〃
7003 OAuth2.0クライアント情報なし 〃
7004 OAuth2.0サポートされていないトークン発行タイプ リクエストボディのgrant_typeを確認してください
8001 OAuth2.0 JWTの作成に失敗しました
8002 OAuth2.0 JWTの検証に失敗しました
8004 OAuth2.0 JWTに対するサポートされていないアルゴリズム
8005 OAuth2.0 JWT Kidの検証に失敗しました
8006 OAuth2.0 JWT署名の検証に失敗しました
8007 OAuth2.0 JWTの異常ペイロード
8008 OAuth2.0サポートされていないトークンタイプ ペイロード内のrefresh_tokenのみが更新可能です
8009 OAuth2.0サポートされていないトークンスコープ
8011 OAuth2.0 JWTが期限切れ

レスポンスボディサンプル（成功）

これは、以下の条件が満たされたときに返されるレスポンスデータの例です。

  • トークンは正常に発行されました。
{
  "code": 100,
  "access_token": "eyJraWQiOiIwYThlMThkOS1hNmZiLTM3ZDMtNjkwYy02Zjg1ZTllNCIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc193aGl0ZWxpc3QiOmZhbHNlLCJwcm9qZWN0X2lkIjoiY29tLmNvbTJ1cy5oaXZlc2RrIiwiZ3JhbnRfdHlwZSI6InVzZXIiLCJ1c2VyX2lkIjoyMDAwMDAxODU1MiwidG9rZW5fdHlwZSI6ImFjY2Vzc190b2tlbiIsImV4cCI6MTc0NTU2MTk4MywiaWF0IjoxNzQ1NTU4MzgzLCJhdXRoX3ZlciI6InY0In0.e4mCIirRpAni4A1ZEF3FDOFng3Da8hq6IqZmyyRQZsc7W3LfFi_id5TIQSDbvmagmT4GcwHztovpoYZxf8blwqES1lJmEVXsBBJ3qpEOAem0K9aVwY0zmOO3A0Eeh6Y0APABewNCpHiKPCMZwxSsMaUE56FfuYgnbhpsipR638VgyPniRVU-Bzcu0Pi2zo-5yUKbg2FCXex510fvZRxqGZPg8Rfhm-jXqAYuwALLIFf2ZykOWqVRFtczfPXwB6fLQrQvQeBnOYcHHnR1q8Fi-Rk_bQPsAffIemGvaC4vUeyx6Szzt_Gok1BsuF76lYZ5ogCn4lAlZ0SJLrgMM2-DNQ",
  "refresh_token": "eyJraWQiOiIwYThlMThkOS1hNmZiLTM3ZDMtNjkwYy02Zjg1ZTllNCIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc193aGl0ZWxpc3QiOmZhbHNlLCJwcm9qZWN0X2lkIjoiY29tLmNvbTJ1cy5oaXZlc2RrIiwiZ3JhbnRfdHlwZSI6InVzZXIiLCJ1c2VyX2lkIjoyMDAwMDAxODU1MiwidG9rZW5fdHlwZSI6InJlZnJlc2hfdG9rZW4iLCJleHAiOjE3NDgxNTAzODMsImlhdCI6MTc0NTU1ODM4MywiYXV0aF92ZXIiOiJ2NCJ9.fvXTfRDYhlk21EY-ngAXbQMgYM9f-rFYPBa_GMV3JDz3cy9wwGfPTnF-VO0WkpxzpPdbG1ZX0HAdIkT4kF873ee2d-g6-JeuIEy0SFcTMpdYWXnlOfsuZlFIkzCm0OB_mlnNo_wxXHvjHM_dFDF-SfK2r9_ga8yLOXDfLJeA4XUYGwwsG3XT9x5Vy8RlUcF2aeuf-2bXdLSD2NGssZh18RTayV2CNtGuX0kj-nABVVTzLWUqbwKSrIVXjlS76zxl3SisUW_pz97iM98yLLRdpe_56_VDPzKEqVmn4bCyhhlAT1LEdu_uudlBY7hSUX0cJzcLAtj_4GReuLU9SnvQpw"
}

レスポンスボディサンプル (失敗)

これは、次の条件が満たされたときに返されるレスポンスデータの例です。

  • トークンの発行に失敗しました。
{
  "code": 1050
}