12min

Methods

  • $pinc.oauth.authorized()
  • $pinc.oauth.authorizedList()
  • $pinc.oauth.processCommand()
  • $pinc.oauth.bind()
  • $pinc.oauth.client.connections()
  • $pinc.oauth.client.display()
  • $pinc.oauth.revoke()

authorized(provider, [userId], callback)

Allows you to query whether the user has previously authorized an Integration. User this interface when you wish to query the authorization status for a single provider.

arguments

Argument

Description

provider

Internal provider name. See Provider reference

userId

optional: Defaults to the data-user-id attribute in the script tag

callback

JavaScript callback.

Example

JS
|

authorizedList(userId, callback)

Gives you a list of providers that the user has authorized

Example

JS
|

processCommand(json_params)

Inititates the OAuth authorization process for the given provider. Ensure that this method is called synchronously on user interaction (onclick etc.). An asynchronous call to this function will block any authorizations that work with popups.

Param

Description

provider

Internal provider name. See Provider reference

user_id

optional: Defaults to the data-user-id attribute in the script tag

Example

JS
|

bind(div)

Pass the div element for scenarios where the div is dynamically added to the page using JavaScript of shadow DOM.

JS
|

revoke(provider,userId)

Invokes the token revocation for the current user. If the provider does no offer API based revocation then the tokens are deleted from the Pathfix databases/caches.

Example

JS
|

Provider reference

Updated 19 Nov 2020
Did this page help?
Yes
No
UP NEXT
$pinc.auth
Documentation powered by archbee