---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# GlideOAuthClientRequest - スコープ対象、グローバル

# GlideOAuthClientRequest - スコープ対象、グローバル {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：6分

GlideOAuthClientRequest API は OAuth クライアント要求を処理するためのメソッドを提供します。

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

## GlideOAuthClientRequest - getGrantType() {#ariaid-title2}

権限許可タイプを取得します。
{#r_GlideOAuthClientRequestGetGrantType__table_qc4_bzf_cr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| none |   |   |
[表 : 1. パラメーター]

{#r_GlideOAuthClientRequestGetGrantType__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestGetGrantType__table_rc4_bzf_cr__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | 権限許可タイプ。 |
[表 : 2. 返される内容]

{#r_GlideOAuthClientRequestGetGrantType__table_rc4_bzf_cr}

## GlideOAuthClientRequest - getHeader(文字列 name) {#ariaid-title3}

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

| 名前 | タイプ | 説明 |
|-|-|-|
| name | 文字列 | パラメーターの名前。 |
[表 : 3. パラメーター]

{#r_GlideOAuthClientRequestGetHeader__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestGetHeader__table_rc4_bzf_cr__entry__2}

| タイプ | 説明 |
|-|-|
| StringMap | HTTP ヘッダーを含む文字列マップ。 |
[表 : 4. 返される内容]

{#r_GlideOAuthClientRequestGetHeader__table_rc4_bzf_cr}

## GlideOAuthClientRequest - getHeaders() {#ariaid-title4}

HTTP ヘッダーを取得します。
{#r_GlideOAuthClientRequestGetHeaders__table_qc4_bzf_cr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| none |   |   |
[表 : 5. パラメーター]

{#r_GlideOAuthClientRequestGetHeaders__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestGetHeaders__table_rc4_bzf_cr__entry__2}

| タイプ | 説明 |
|-|-|
| StringMap | HTTP ヘッダーを含む文字列マップ。 |
[表 : 6. 返される内容]

{#r_GlideOAuthClientRequestGetHeaders__table_rc4_bzf_cr}

## GlideOAuthClientRequest - getParameter(文字列 name) {#ariaid-title5}

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

| 名前 | タイプ | 説明 |
|-|-|-|
| name | 文字列 | パラメーターが必要なパラメーター名。 |
[表 : 7. パラメーター]

{#r_GlideOAuthClientRequestGetParameter__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestGetParameter__table_rc4_bzf_cr__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | パラメーター。 |
[表 : 8. 返される内容]

{#r_GlideOAuthClientRequestGetParameter__table_rc4_bzf_cr}

## GlideOAuthClientRequest - getPassword() {#ariaid-title6}

パスワードを取得します。
{#r_GlideOAuthClientRequestGetPassword__table_qc4_bzf_cr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| none |   |   |
[表 : 9. パラメーター]

{#r_GlideOAuthClientRequestGetPassword__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestGetPassword__table_rc4_bzf_cr__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | パスワード。 |
[表 : 10. 返される内容]

{#r_GlideOAuthClientRequestGetPassword__table_rc4_bzf_cr}

## GlideOAuthClientRequest - getRefreshToken() {#ariaid-title7}

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

| 名前 | タイプ | 説明 |
|-|-|-|
| none |   |   |
[表 : 11. パラメーター]

{#r_GlideOAuthClientRequestGetRefreshToken__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestGetRefreshToken__table_rc4_bzf_cr__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | リフレッシュトークン。 |
[表 : 12. 返される内容]

{#r_GlideOAuthClientRequestGetRefreshToken__table_rc4_bzf_cr}

## GlideOAuthClientRequest - getScope() {#ariaid-title8}

スコープを取得します。
{#r_GlideOAuthClientRequestGetScope__table_qc4_bzf_cr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| none |   |   |
[表 : 13. パラメーター]

{#r_GlideOAuthClientRequestGetScope__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestGetScope__table_rc4_bzf_cr__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | スコープ。 |
[表 : 14. 返される内容]

{#r_GlideOAuthClientRequestGetScope__table_rc4_bzf_cr}

## GlideOAuthClientRequest - getUserName() {#ariaid-title9}

ユーザー名を取得します。
{#r_GlideOAuthClientRequestGetUserName__table_qc4_bzf_cr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| none |   |   |
[表 : 15. パラメーター]

{#r_GlideOAuthClientRequestGetUserName__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestGetUserName__table_rc4_bzf_cr__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | ユーザー名。 |
[表 : 16. 返される内容]

{#r_GlideOAuthClientRequestGetUserName__table_rc4_bzf_cr}

## GlideOAuthClientRequest - setGrantType(文字列 grantType) {#ariaid-title10}

指定した文字列の権限許可タイプを設定します。
注:  
OAuth プロバイダープロファイルでまだ定義されていない場合にのみ、権限許可タイプを設定する必要があります。
{#r_GlideOAuthClientRequestSetGrantType__table_qc4_bzf_cr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| name | 文字列 | 権限許可タイプ。 |
[表 : 17. パラメーター]

{#r_GlideOAuthClientRequestSetGrantType__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestSetGrantType__table_rc4_bzf_cr__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 18. 返される内容]

{#r_GlideOAuthClientRequestSetGrantType__table_rc4_bzf_cr}

## GlideOAuthClientRequest - setHead(文字列 name, 文字列 value) {#ariaid-title11}

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

| 名前 | タイプ | 説明 |
|-|-|-|
| name | 文字列 | パラメーターの名前。 |
| value | 文字列 | パラメーターの値。 |
[表 : 19. パラメーター]

{#r_GlideOAuthClientRequestSetHead__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestSetHead__table_rc4_bzf_cr__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 20. 返される内容]

{#r_GlideOAuthClientRequestSetHead__table_rc4_bzf_cr}

## GlideOAuthClientRequest - setParameter(文字列 name, 文字列 value) {#ariaid-title12}

指定した文字列の名前と値のペアのパラメーターを設定します。
{#r_GOACR-SetParameters_N_V__table_qc4_bzf_cr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| name | 文字列 | パラメーターが必要なパラメーター名。 |
| value | 文字列 | パラメーターの値。 |
[表 : 21. パラメーター]

{#r_GOACR-SetParameters_N_V__table_qc4_bzf_cr} {#r_GOACR-SetParameters_N_V__table_rc4_bzf_cr__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 22. 返される内容]

{#r_GOACR-SetParameters_N_V__table_rc4_bzf_cr}

## GlideOAuthClientRequest - setPassword(文字列 password) {#ariaid-title13}

指定した文字列を使用してパスワードを設定します。
{#r_GlideOAuthClientRequestSetPassword__table_qc4_bzf_cr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| パスワード | 文字列 | ユーザー名。 |
[表 : 23. パラメーター]

{#r_GlideOAuthClientRequestSetPassword__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestSetPassword__table_rc4_bzf_cr__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 24. 返される内容]

{#r_GlideOAuthClientRequestSetPassword__table_rc4_bzf_cr}

## GlideOAuthClientRequest - setRefreshToken(文字列 refreshToken) {#ariaid-title14}

指定した文字列を使用してリフレッシュトークンを設定します。
{#r_GlideOAuthClientRequestSetRefreshToken__table_qc4_bzf_cr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| refreshToken | 文字列 | リフレッシュトークン。 |
[表 : 25. パラメーター]

{#r_GlideOAuthClientRequestSetRefreshToken__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestSetRefreshToken__table_rc4_bzf_cr__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 26. 返される内容]

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


         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(文字列 scope) {#ariaid-title15}

指定した文字列のスコープを設定します。
注:  
OAuth プロバイダーでまだ定義されていない場合にのみ、スコープを設定する必要があります。
{#r_GlideOAuthClientRequestSetScope__table_qc4_bzf_cr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| scope | 文字列 | スコープ。 |
[表 : 27. パラメーター]

{#r_GlideOAuthClientRequestSetScope__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestSetScope__table_rc4_bzf_cr__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 28. 返される内容]

{#r_GlideOAuthClientRequestSetScope__table_rc4_bzf_cr}

## GlideOAuthClientRequest - setUserName(文字列 userName) {#ariaid-title16}

指定した文字列を使用してユーザー名を設定します。
{#r_GlideOAuthClientRequestSetUserName__table_qc4_bzf_cr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| userName | 文字列 | ユーザー名。 |
[表 : 29. パラメーター]

{#r_GlideOAuthClientRequestSetUserName__table_qc4_bzf_cr} {#r_GlideOAuthClientRequestSetUserName__table_rc4_bzf_cr__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 30. 返される内容]

{#r_GlideOAuthClientRequestSetUserName__table_rc4_bzf_cr}