GlideOAuthClientRequest:スコープ指定、グローバル

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間:6分
  • GlideOAuthClientRequest API は、OAuth クライアント要求を処理するためのメソッドを提供します。

    この API は、グローバルスクリプトおよびスコープ付きスクリプトで使用できます。スコープ付きスクリプトでは、 sn_auth 名前空間識別子を使用します。

    GlideOAuthClientRequest:getGrantType()

    権限許可タイプを取得します。

    表 : 1. パラメーター
    名前 タイプ 説明
    なし
    表 : 2. 返される内容
    タイプ 説明
    文字列 権限許可タイプ。

    GlideOAuthClientRequest:getHeader(文字列名)

    指定した文字列の HTTP ヘッダーを取得します。

    表 : 3. パラメーター
    名前 タイプ 説明
    name 文字列 パラメーターの名前。
    表 : 4. 返される内容
    タイプ 説明
    StringMap HTTP ヘッダーを含む文字列マップ。

    GlideOAuthClientRequest - getHeaders()

    HTTP ヘッダーを取得します。

    表 : 5. パラメーター
    名前 タイプ 説明
    なし
    表 : 6. 返される内容
    タイプ 説明
    StringMap HTTP ヘッダーを含む文字列マップ。

    GlideOAuthClientRequest:getParameter(文字列名)

    指定したパラメーター名のパラメーターを取得します。

    表 : 7. パラメーター
    名前 タイプ 説明
    name 文字列 パラメーターの指定するパラメーター名。
    表 : 8. 返される内容
    タイプ 説明
    文字列 パラメーター。

    GlideOAuthClientRequest - getPassword()

    パスワードを取得します。

    表 : 9. パラメーター
    名前 タイプ 説明
    なし
    表 : 10. 返される内容
    タイプ 説明
    文字列 パスワード。

    GlideOAuthClientRequest - getRefreshToken()

    リフレッシュトークンを取得します。

    表 : 11. パラメーター
    名前 タイプ 説明
    なし
    表 : 12. 返される内容
    タイプ 説明
    文字列 リフレッシュトークン。

    GlideOAuthClientRequest:getScope()

    スコープを取得します。

    表 : 13. パラメーター
    名前 タイプ 説明
    なし
    表 : 14. 返される内容
    タイプ 説明
    文字列 スコープ。

    GlideOAuthClientRequest:getUserName()

    ユーザー名を取得します。

    表 : 15. パラメーター
    名前 タイプ 説明
    なし
    表 : 16. 返される内容
    タイプ 説明
    文字列 ユーザー名。

    GlideOAuthClientRequest:setGrantType(文字列 grantType)

    指定する文字列の権限許可タイプを設定します。

    注:
    権限許可タイプは、OAuth プロバイダープロファイルでまだ定義されていない場合にのみ設定する必要があります。
    表 : 17. パラメーター
    名前 タイプ 説明
    name 文字列 権限許可タイプ。
    表 : 18. 返される内容
    タイプ 説明
    なし

    GlideOAuthClientRequest - setHead(文字列名, 文字列値)

    指定した文字列の HTTP ヘッダーを取得します。

    注:
    setHead(文字列名、文字列値) はグローバルで使用されます。このメソッドに相当するスコープは setHeader(String name, String value) です。
    表 : 19. パラメーター
    名前 タイプ 説明
    name 文字列 パラメーターの名前。
    value 文字列 パラメーターの値。
    表 : 20. 返される内容
    タイプ 説明
    なし

    GlideOAuthClientRequest:setParameter(文字列名, 文字列値)

    指定する文字列の名前と値のペアのパラメーターを設定します。

    表 : 21. パラメーター
    名前 タイプ 説明
    name 文字列 パラメーターの指定するパラメーター名。
    value 文字列 パラメーターの値。
    表 : 22. 返される内容
    タイプ 説明
    なし

    GlideOAuthClientRequest:setPassword(文字列パスワード)

    指定した文字列でパスワードを設定します。

    表 : 23. パラメーター
    名前 タイプ 説明
    password 文字列 ユーザー名。
    表 : 24. 返される内容
    タイプ 説明
    なし

    GlideOAuthClientRequest:setRefreshToken(文字列 refreshToken)

    指定した文字列でリフレッシュトークンを設定します。

    表 : 25. パラメーター
    名前 タイプ 説明
    refreshToken 文字列 リフレッシュトークン。
    表 : 26. 返される内容
    タイプ 説明
    なし

    この例は、リソース所有者のパスワード権限許可タイプの要求を示しています。

    
         var tokenRequest =new GlideOAuthClientRequest();
         tokenRequest.setGrantType("password");
         tokenRequest.setUserName("itil");
         tokenRequest.setPassword("itil");
         tokenRequest.setScope(null);
     
         var oAuthClient =new GlideOAuthClient();var tokenResponse = oAuthClient.requestToken("TestClient", tokenRequest);
         gs.log("Error:"+ tokenResponse.getErrorMessage());
     
         var token = tokenResponse.getToken();if(token){
           gs.log("AccessToken:"+ token.getAccessToken());
           gs.log("AccessTokenExpiresIn:"+ token.getExpiresIn());
           gs.log("RefreshToken:"+ token.getRefreshToken());
    

    この例は、リフレッシュトークン権限許可タイプの要求を示しています。

    
         var tokenRequest =new GlideOAuthClientRequest();
         tokenRequest.setGrantType("refresh_token");
         tokenRequest.setRefreshToken("N-GtdSVLkWP_Cr-TysXdmNy59ZYafu5ZzAS4YaSluXDm0kCkInEnu-hwM5SsGYSFwKJ6xauVmoaq7xJNoalXFQ");
         tokenRequest.setScope(null);
     
         var oAuthClient =new GlideOAuthClient();
         tokenResponse = oAuthClient.requestToken("TestClient", tokenRequest);
         gs.log("Error:"+ tokenResponse.getErrorMessage());
         token = tokenResponse.getToken();if( token){
            gs.log("AccessToken:"+ token.getAccessToken());
            gs.log("AccessTokenExpiresIn:"+ token.getExpiresIn());
            gs.log("AccessTokenSysID:"+ token.getAccessTokenSysID());
            gs.log("RefreshToken:"+ token.getRefreshToken());
            gs.log("RefreshTokenSysID:"+ token.getRefreshTokenSysID());

    GlideOAuthClientRequest:setScope(文字列スコープ)

    指定する文字列のスコープを設定します。

    注:
    OAuth プロバイダーでスコープがまだ定義されていない場合にのみ設定する必要があります。
    表 : 27. パラメーター
    名前 タイプ 説明
    scope 文字列 スコープ。
    表 : 28. 返される内容
    タイプ 説明
    なし

    GlideOAuthClientRequest:setUserName(文字列 userName)

    指定した文字列でユーザー名を設定します。

    表 : 29. パラメーター
    名前 タイプ 説明
    userName 文字列 ユーザー名。
    表 : 30. 返される内容
    タイプ 説明
    なし