GlideOAuthToken - Scoped, Global

The GlideOAuthToken API provides methods for retrieving OAuth access token and information about the access token.

You can use this API in global and scoped scripts. In scoped scripts use the sn_auth namespace identifier.

GlideOAuthToken - getAccessToken()

Retrieves the access token associated with the GlideOAuthToken object.

Table 1. Parameters

Name	Type	Description
None

Table 2. Returns

Type	Description
String	Access token.

This example code shows how to retrieve access and refresh tokens from the instance database. See also GlideOAuthClient.

function dumpToken(token) {
  if(token) {
     gs.info("AccessToken:" + token.getAccessToken());
     gs.info("AccessTokenExpiresIn:" + token.getExpiresIn());
     gs.info("RefreshToken:" + token.getRefreshToken());
  }
}

var oAuthClient = new  sn_auth.GlideOAuthClient();
var token = oAuthClient.getToken('248e3017c302301089a7dd5c2840dda5', '9c4e78d3c302301089a7dd5c2840dd76');
dumpToken(token);

Output:

*** Script: AccessToken:6MRxD3TRYYvIaoKr-JCy3KiaOxBPu4C9k8oafo3MYf9q8zDyHQr8UzMSM3Md2alfaES1rzSYe5ydqgbOwpm7TA
*** Script: AccessTokenExpiresIn:1207
*** Script: RefreshToken:sc0iTK-0PcVkRi14HXPM3vT0FyOPO8iCqC10huQoDSSLBGUSnmEv_fUfJzGWCWBb_StsXIOz6r8qF-hRhURWTA

GlideOAuthToken - getAccessTokenSysID()

Deprecated. Retrieves the sys_id of the token ID associated with the GlideOAuthToken object.

Table 3. Parameters

Name	Type	Description
None

Table 4. Returns

Type	Description
String	Sys_id of the access token.

GlideOAuthToken - getExpiresIn()

Retrieves the lifespan of the access token associated with the GlideOAuthToken object.

Table 5. Parameters

Name	Type	Description
None

Table 6. Returns

Type	Description
Number (Long)	Lifespan of the token. Unit: Seconds

This example code shows how to retrieve access and refresh tokens from the instance database. See also GlideOAuthClient.

function dumpToken(token) {
  if(token) {
     gs.info("AccessToken:" + token.getAccessToken());
     gs.info("AccessTokenExpiresIn:" + token.getExpiresIn());
     gs.info("RefreshToken:" + token.getRefreshToken());
  }
}

var oAuthClient = new  sn_auth.GlideOAuthClient();
var token = oAuthClient.getToken('248e3017c302301089a7dd5c2840dda5', '9c4e78d3c302301089a7dd5c2840dd76');
dumpToken(token);

Output:

*** Script: AccessToken:6MRxD3TRYYvIaoKr-JCy3KiaOxBPu4C9k8oafo3MYf9q8zDyHQr8UzMSM3Md2alfaES1rzSYe5ydqgbOwpm7TA
*** Script: AccessTokenExpiresIn:1207
*** Script: RefreshToken:sc0iTK-0PcVkRi14HXPM3vT0FyOPO8iCqC10huQoDSSLBGUSnmEv_fUfJzGWCWBb_StsXIOz6r8qF-hRhURWTA

GlideOAuthToken - getRefreshToken()

Refreshes the token associated with the GlideOAuthToken object.

Table 7. Parameters

Name	Type	Description
None

Table 8. Returns

Type	Description
String	Refreshed token.

This example code shows how to retrieve access and refresh tokens from the instance database. See also GlideOAuthClient.

function dumpToken(token) {
  if(token) {
     gs.info("AccessToken:" + token.getAccessToken());
     gs.info("AccessTokenExpiresIn:" + token.getExpiresIn());
     gs.info("RefreshToken:" + token.getRefreshToken());
  }
}

var oAuthClient = new  sn_auth.GlideOAuthClient();
var token = oAuthClient.getToken('248e3017c302301089a7dd5c2840dda5', '9c4e78d3c302301089a7dd5c2840dd76');
dumpToken(token);

Output:

*** Script: AccessToken:6MRxD3TRYYvIaoKr-JCy3KiaOxBPu4C9k8oafo3MYf9q8zDyHQr8UzMSM3Md2alfaES1rzSYe5ydqgbOwpm7TA
*** Script: AccessTokenExpiresIn:1207
*** Script: RefreshToken:sc0iTK-0PcVkRi14HXPM3vT0FyOPO8iCqC10huQoDSSLBGUSnmEv_fUfJzGWCWBb_StsXIOz6r8qF-hRhURWTA

GlideOAuthToken - getRefreshTokenSysID()

Deprecated. Retrieves the sys_id of the refresh token.

Table 9. Parameters

Name	Type	Description
None

Table 10. Returns

Type	Description
String	Sys_id of the refresh token.

GlideOAuthToken - getScope()

Retrieves the token scope, which is the amount of access granted by the access token.

Table 11. Parameters

Name	Type	Description
None

Table 12. Returns

Type	Description
String	Scope of the access token.