Child pages
  • OAuthService
Skip to end of metadata
Go to start of metadata

Refresh page Dec 06, 2021 17:41

Supported Clients
NGClient

Methods Summary
OAuthRequest createDeleteRequest(resourceURL) Create a DELETE request.
OAuthRequest createGetRequest(resourceURL) Create a GET request for a resource.
OAuthRequest createPostRequest(resourceURL) Create a POST request.
OAuthRequest createPutRequest(resourceURL) Create a PUT request.
OAuthRequest createRequest(requestType, resourceURL) Creates a JSOAuthRequest for with the enum of RequestType (GET, PUT, DELETE, etc) for a resource url.
OAuthResponse executeGetRequest(resourceURL) This is quick method by executing a GET request and returning right away the OAuthResponse So it would be the same as executeRequest(createRequest(RequestType.
OAuthResponse executeRequest(request) Method to execute requests that are made, and configured by #createRequest(Verb,String)
Number getAccessExpiresIn() Returns the number of seconds left until the access token expires.
String getAccessToken() Get the access token currently set on the service.
Number getAccessTokenLifetime() Return the token lifetime in seconds.
String getAuthorizationURL()
String getAuthorizationURL(params) Get the authorization url with some additional parameters.
String getIdToken() Obtain the Openid token if it is available.
String getRefreshToken() Return the refresh token.
Boolean isAccessTokenExpired() Checks if the access token is expired.
String refreshToken() Obtains a new access token if the OAuth api supports it.
void revokeToken(token) Revoke the provided access token.
void setAccessToken(code) Configure the oauth service with an access token using the scope that was initially set when creating the service.
void setAccessToken(code, scope) Configure the oauth service with an access token for the specified scope.

Methods Details

createDeleteRequest(resourceURL)

Create a DELETE request.

Parameters

String resourceURL the url of the resource to be deleted

Returns

OAuthRequest the request object

Supported Clients

NGClient

Sample

var putRequest = service.createDeleteRequest("https://graph.microsoft.com/v1.0/me/drive/root:/FolderAA/FileBB.txt:/content");
var response = putRequest.execute();
if (response.getCode() == 204) {
		application.output("File was deleted "+response.getBody());
	}
else
{
		application.output('http status '+response.getCode());
		application.output("File could not be deleted: "+response.getBody())
}

createGetRequest(resourceURL)

Create a GET request for a resource.

Parameters

String resourceURL the url of the resource which you want to get

Returns

OAuthRequest the request object

Supported Clients

NGClient

Sample

var getRequest = service.createGetRequest("https://api.linkedin.com/v2/me");
getRequest.addHeader("Accept", "application/json");

var response = getRequest.execute();
if (response.getCode() == 200) {
		var json = response.getAsJSON();
		application.output("Name is "+json.firstName);
	}
else
{
		application.output("ERROR http status "+response.getCode());
		application.output(response.getBody())
}

createPostRequest(resourceURL)

Create a POST request.

Parameters

String resourceURL the url where the enclosed entity will be stored

Returns

OAuthRequest the request object

Supported Clients

NGClient

Sample

var postRequest = service.createPostRequest("https://.....");
postRequest.addHeader("Content-Type", "text/plain");
postRequest.addBodyParameter("param1", "value1");
var response = postRequest.execute();

createPutRequest(resourceURL)

Create a PUT request.

Parameters

String resourceURL the url where the enclosed entity will be stored

Returns

OAuthRequest the request object

Supported Clients

NGClient

Sample

var putRequest = service.createPutRequest("https://graph.microsoft.com/v1.0/me/drive/root:/FolderAA/FileBB.txt:/content");
putRequest.addHeader("Content-Type", "text/plain");
putRequest.setPayload("ABC");
var response = putRequest.execute();
if (response.getCode() == 201) {
		application.output("New file was created "+response.getBody());
	}
else
{
		application.output("ERROR http status "+response.getCode());
		application.output("File could not be created: "+response.getBody())
}

createRequest(requestType, resourceURL)

Creates a JSOAuthRequest for with the enum of RequestType (GET, PUT, DELETE, etc) for a resource url.

Parameters

enum requestType one of the types of plugins.oauth.RequestType
String resourceURL the url of the resource you want to access

Returns

OAuthRequest a JSOAuthRequest object

Supported Clients

NGClient

Sample

var request = service.createRequest(plugins.oauth.RequestType.GET, "https://api.linkedin.com/v2/me");
request.addHeader("Accept", "application/json");

var response = request.execute();
if (response.getCode() == 200) {
		var json = response.getAsJSON();
		application.output("Name is "+json.firstName);
	}
else
{
		application.output("ERROR http status "+response.getCode());
		application.output(response.getBody())
}

executeGetRequest(resourceURL)

This is quick method by executing a GET request and returning right away the OAuthResponse
So it would be the same as executeRequest(createRequest(RequestType.GET, url))

Parameters

String resourceURL ;

Returns

OAuthResponse the OAuthResponse object

Supported Clients

NGClient

Sample

 

executeRequest(request)

Method to execute requests that are made, and configured by  #createRequest(Verb,String)

Parameters

OAuthRequest request the JSOAuthRequest object that was created by #createRequest(Verb,String)

Returns

OAuthResponse the OAuthResponse object

Supported Clients

NGClient

Sample

var request = service.createRequest(plugins.oauth.RequestType.GET, "https://api.linkedin.com/v2/me");
request.addHeader("Accept", "application/json");

var response = service.executeRequest(request);
if (response.getCode() == 200) {
		var json = response.getAsJSON();
		application.output("Name is "+json.firstName);
	}
else
{
		application.output("ERROR http status "+response.getCode());
		application.output(response.getBody())
}

getAccessExpiresIn()

Returns the number of seconds left until the access token expires.

Returns

Number seconds left untol the access token expires.

Supported Clients

NGClient

Sample

var seconds = service.getAccessExpiresIn();
 if (seconds < 60)
 {
 	application.output("The access token is going to expire in less than 1 minute! Use service.refreshToken() to get a new one");
 }
 else
 {
 	application.output("Make some requests");
 }

getAccessToken()

Get the access token currently set on the service.

Returns

String the access token or null if it was not set

Supported Clients

NGClient

Sample

 

getAccessTokenLifetime()

Return the token lifetime in seconds.

Returns

Number the token lifetime as it was retrieved by the OAuth provider with the access token

Supported Clients

NGClient

Sample

 

getAuthorizationURL()

Returns

Supported Clients

NGClient

Sample

 

getAuthorizationURL(params)

Get the authorization url with some additional parameters.

Parameters

Object params a json containing the parameters and their values e.g. {'param1': 'value1', 'param2': 'value2'}

Returns

String the authorization url with the provided parameters appended to the query string.

Supported Clients

NGClient

Sample

 

getIdToken()

Obtain the Openid token if it is available.

Returns

String the id token, or null if was not set on the service.

Supported Clients

NGClient

Sample

 

getRefreshToken()

Return the refresh token.

Returns

String the refresh token or null if it is not present

Supported Clients

NGClient

Sample

 

isAccessTokenExpired()

Checks if the access token is expired. Returns false if the access token expire information is not set.

Returns

Boolean true if the access token is expired, false otherwise

Supported Clients

NGClient

Sample

 

refreshToken()

Obtains a new access token if the OAuth api supports it.

Returns

String The new access token issued by the authorization server

Supported Clients

NGClient

Sample

accessToken = service.refreshToken();

revokeToken(token)

Revoke the provided access token.

Parameters

String token to revoke

Supported Clients

NGClient

Sample

 

setAccessToken(code)

Configure the oauth service with an access token using the scope that was initially set when creating the service.

Parameters

String code the authorization code used to request and access token

Supported Clients

NGClient

Sample

 

setAccessToken(code, scope)

Configure the oauth service with an access token for the specified scope.

Parameters

String code the authorization code used to request an access token
String scope the scope for which to obtain an access token

Supported Clients

NGClient

Sample

 

  • No labels