OAuthUtil - グローバル

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：2分

    • OAuthUtil スクリプトインクルードは、実行時に要求パラメーターを変更し、トークン応答を解析します。

    外部 OAuth プロバイダーからアプリケーション/JSON タイプの応答以外の応答が返される場合は、お使いのバージョンのスクリプトインクルードをカスタマイズすることで、別のフォーマットの応答を解析できます。このスクリプトインクルードを拡張またはコピーし、サードパーティの OAuth プロバイダーを対象とする [アプリケーションレジストリー] フォームの [OAuth API スクリプト] フィールドから、お使いのバージョンを参照します。カスタムのスクリプトインクルード名は OAuthで始まる必要があります。

    たとえば、OAuth プロバイダーが値 https://outlook.office365.com のリソースパラメーターを必要とする場合、コードは次のようになります。 
    preprocessAccessToken: function(requestParamMap) {
  requestParamMap.put("resource", "https://outlook.office365.com");
},

    OAuthUtil - getOAuthProfile()

    現在の OAuth プロファイルを表す GlideRecord を返します。

    表 : 1. パラメーター
    名前 タイプ 説明
    なし
    表 : 2. 返される内容
    タイプ 説明
    GlideRecord 現在の OAuth プロファイルを表す GlideRecord

    OAuthUtil - interceptRequestParameters(requestParamMap)

    名前と値のペアを要求パラメーターに追加します。

    表 : 3. パラメーター
    名前 タイプ 説明
    requestParamMap 文字列 追加する名前と値のペア。
    表 : 4. 返される内容
    タイプ 説明
    なし

    OAuthUtil - parseTokenResponse(accessTokenResponse)

    受信したトークンをパラメーターマップに解析します。

    表 : 5. パラメーター
    名前 タイプ 説明
    accessTokenResponse 文字列 解析するアクセストークン応答。
    表 : 6. 返される内容
    タイプ 説明
    なし

    OAuthUtil - setEndpoint(url)

    OAuth 要求のエンドポイントを設定します。

    表 : 7. パラメーター
    名前 タイプ 説明
    url 文字列 要求の URL エンドポイント
    表 : 8. 返される内容
    タイプ 説明
    なし

    OAuthUtil - setHeader(headerName, headerValue)

    送信トークン要求にヘッダーを追加します。

    表 : 9. パラメーター
    名前 タイプ 説明
    headerName 文字列 トークン要求のヘッダーの名前
    headerValue 文字列 トークン要求のヘッダーの値
    表 : 10. 返される内容
    タイプ 説明
    なし

    OAuthUtil - setQueryParameter(paramName, paramValue)

    OAuth 要求にクエリーパラメーターを追加します。

    表 : 11. パラメーター
    名前 タイプ 説明
    paramName 文字列 パラメーターの名前
    paramValue 文字列 パラメーターの値
    表 : 12. 返される内容
    タイプ 説明
    なし