OAuth API 応答パラメーター

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:2分
  • OAuth 2.0 API は、次のパラメーターを name:value ペアとして含む JSON 応答を生成します。

    表 : 1. アクセストークン応答パラメーター
    応答パラメーター 説明
    scope アクセストークンによって付与されるアクセスの範囲。スコープは常に useraccount です。これは、アクセストークンがトークンを承認したユーザーアカウントと同じ権限を持つことを意味します。たとえば、Abel Tuter がログイン認証情報を提供してアプリケーションを承認した場合、その結果生じるアクセストークンは Abel Tuter と同じアクセス権限をトークンベアラーに付与します。
    token_type OAuth RFC で定義されている要求によって発行されたトークンのタイプ。トークンタイプは常にベアラー です。これは、アクセストークンを持っているすべてのユーザーが、暗号化キーを提供しなくても保護されたリソースにアクセスできることを意味します。OAuth 2.0 でのベアラートークンの使用方法の詳細については、RFC6750 を参照してください。
    expires_in アクセストークンの有効期間 (秒単位)
    refresh_token リフレッシュトークンの文字列値
    access_token アクセストークンの文字列値アクセストークンの有効期限内に行われたアクセス要求は、常に現在のアクセストークンを返します。
    format [オプション] 応答の出力形式。この値は常に JSON です。
    注:
    OAuth プロバイダーが応答の本文を「Content-Type」でなく「content-type」として送信すると、OAuth HTTP クライアントで応答が正しく解析されない可能性があります。この問題を修正するには、次のパラメーターを使用してシステムプロパティを作成します。
    フィールド
    名前 glide.oauth.inhouse.httpclient.enabled
    タイプ true | false
    false

    システムプロパティの作成の詳細については、「システムプロパティを追加する」を参照してください。

    次の例は、アクセストークン要求によって返される JSON 文字列を示しています。(読みやすくするためにスペースを追加しました)。

    
    {"scope":"useraccount","token_type":"Bearer","expires_in":1800,
    "refresh_token":"w599voG89897rGVDmdp12WA681r9E5948c1CJTPi8g4HGc4NWaz62k6k1K0FMxHW40H8yOO3Hoe",
    "access_token":"F0jh9korTyzd9kaZqZ0SzjKZuS3ut0i4P46Lc52m2JYHiLIcqzFAumpyxshU9mMQ13gJHtxD2fy"}