oauth_tokens

Creates, updates, deletes, gets or lists an oauth_tokens resource.

Overview

Name	oauth_tokens
Type	Resource
Id	azure_extras.agrifood_farming.oauth_tokens

Fields

The following fields are returned by SELECT queries:

get_oauth_connection_link

Name	Datatype	Description
value	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_oauth_connection_link	select	endpoint		Returns Connection link needed in the OAuth flow.
list_raw	exec	endpoint	isValid, minCreatedDateTime, maxCreatedDateTime, minLastModifiedDateTime, maxLastModifiedDateTime, skipToken	Returns a list of OAuthToken documents.
get_cascade_delete_job_details	exec	job_id, endpoint		Get remove job for OAuth token.
create_cascade_delete_job	exec	job_id, partyId, oauthProviderId, endpoint		Create remove job for OAuth token.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme). (default: )
job_id	string	Job Id supplied by end user. Required.
oauthProviderId	string	Id of the OAuthProvider. Required.
partyId	string	Id of the party. Required.
isValid	boolean	If the token object is valid. Default value is None.
maxCreatedDateTime	string (date-time)	Maximum creation date of resource (inclusive). Default value is None.
maxLastModifiedDateTime	string (date-time)	Maximum last modified date of resource (inclusive). Default value is None.
minCreatedDateTime	string (date-time)	Minimum creation date of resource (inclusive). Default value is None.
minLastModifiedDateTime	string (date-time)	Minimum last modified date of resource (inclusive). Default value is None.
skipToken	string	Skip token for getting next set of results. Default value is None.

SELECT examples

get_oauth_connection_link

Returns Connection link needed in the OAuth flow.

SELECT
value
FROM azure_extras.agrifood_farming.oauth_tokens
WHERE endpoint = '{{ endpoint }}' -- required
;

Lifecycle Methods

list_raw

Returns a list of OAuthToken documents.

EXEC azure_extras.agrifood_farming.oauth_tokens.list_raw 
@endpoint='{{ endpoint }}' --required, 
@isValid={{ isValid }}, 
@minCreatedDateTime='{{ minCreatedDateTime }}', 
@maxCreatedDateTime='{{ maxCreatedDateTime }}', 
@minLastModifiedDateTime='{{ minLastModifiedDateTime }}', 
@maxLastModifiedDateTime='{{ maxLastModifiedDateTime }}', 
@skipToken='{{ skipToken }}'
;

get_cascade_delete_job_details

Get remove job for OAuth token.

EXEC azure_extras.agrifood_farming.oauth_tokens.get_cascade_delete_job_details 
@job_id='{{ job_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

create_cascade_delete_job

Create remove job for OAuth token.

EXEC azure_extras.agrifood_farming.oauth_tokens.create_cascade_delete_job 
@job_id='{{ job_id }}' --required, 
@partyId='{{ partyId }}' --required, 
@oauthProviderId='{{ oauthProviderId }}' --required, 
@endpoint='{{ endpoint }}' --required
;