---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# OAuthUtil - Global

# OAuthUtil - Global {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read

The OAuthUtil script include modifies request parameters and parses the token response during runtime.

If the external OAuth provider returns a response other than an application/JSON type response,
you can customize your own version of this script include to parse responses that are in
different format. Extend or copy this script include, and then reference your version from the
OAuth API Script field on the Application Registry form for third-party
OAuth providers. The custom script include name must start with <kbd class="ph userinput">OAuth</kbd>.  
For example, if the OAuth provider requires a resource parameter with value https://outlook.office365.com, the code would look like:

    preprocessAccessToken: function(requestParamMap) {
      requestParamMap.put("resource", "https://outlook.office365.com");
    },

## OAuthUtil - getOAuthProfile() {#ariaid-title2}

Returns a GlideRecord representing the current OAuth profile
{#r_OAuthUtilgetOAuthProfile__table_qc4_bzf_cr__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 1. Parameters]

{#r_OAuthUtilgetOAuthProfile__table_qc4_bzf_cr} {#r_OAuthUtilgetOAuthProfile__table_rc4_bzf_cr__entry__2}

| Type | Description |
|-|-|
| GlideRecord | GlideRecord representing the current OAuth profile |
[Table 2. Returns]

{#r_OAuthUtilgetOAuthProfile__table_rc4_bzf_cr}

## OAuthUtil - interceptRequestParameters(requestParamMap) {#ariaid-title3}

Adds a name:value pair to the request parameters.
{#r_OAuthUtilinterceptRequestParameters__table_qc4_bzf_cr__entry__3}

| Name | Type | Description |
|-|-|-|
| requestParamMap | String | The name:value pair you want to add. |
[Table 3. Parameters]

{#r_OAuthUtilinterceptRequestParameters__table_qc4_bzf_cr} {#r_OAuthUtilinterceptRequestParameters__table_rc4_bzf_cr__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 4. Returns]

{#r_OAuthUtilinterceptRequestParameters__table_rc4_bzf_cr}

## OAuthUtil - parseTokenResponse(accessTokenResponse) {#ariaid-title4}

Parses the token received into a parameter map.
{#r_OAuthUtilParseTokenResponse__table_qc4_bzf_cr__entry__3}

| Name | Type | Description |
|-|-|-|
| accessTokenResponse | String | The access token response that you want to parse. |
[Table 5. Parameters]

{#r_OAuthUtilParseTokenResponse__table_qc4_bzf_cr} {#r_OAuthUtilParseTokenResponse__table_rc4_bzf_cr__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 6. Returns]

{#r_OAuthUtilParseTokenResponse__table_rc4_bzf_cr}

## OAuthUtil - setEndpoint(url) {#ariaid-title5}

Set the endpoiont for your OAuth request
{#r_OAuthUtilsetEndpoint__table_qc4_bzf_cr__entry__3}

| Name | Type | Description |
|-|-|-|
| url | String | URL endpoint for your request |
[Table 7. Parameters]

{#r_OAuthUtilsetEndpoint__table_qc4_bzf_cr} {#r_OAuthUtilsetEndpoint__table_rc4_bzf_cr__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 8. Returns]

{#r_OAuthUtilsetEndpoint__table_rc4_bzf_cr}

## OAuthUtil - setHeader(headerName, headerValue) {#ariaid-title6}

Add a header to an outbound token request.
{#r_OAuthUtilsetHeader__table_qc4_bzf_cr__entry__3}

| Name | Type | Description |
|-|-|-|
| headerName | String | Name of your token request header |
| headerValue | String | Value of your token request header |
[Table 9. Parameters]

{#r_OAuthUtilsetHeader__table_qc4_bzf_cr} {#r_OAuthUtilsetHeader__table_rc4_bzf_cr__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 10. Returns]

{#r_OAuthUtilsetHeader__table_rc4_bzf_cr}

## OAuthUtil - setQueryParameter(paramName, paramValue) {#ariaid-title7}

Add a query parameter to an OAuth request.
{#r_OAuthUtilsetQueryParameter__table_qc4_bzf_cr__entry__3}

| Name | Type | Description |
|-|-|-|
| paramName | String | Name of your parameter |
| paramValue | String | Value of your parameter |
[Table 11. Parameters]

{#r_OAuthUtilsetQueryParameter__table_qc4_bzf_cr} {#r_OAuthUtilsetQueryParameter__table_rc4_bzf_cr__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 12. Returns]

{#r_OAuthUtilsetQueryParameter__table_rc4_bzf_cr}