Process Developer

Back Next

Creating an OAuth Service

Use the following procedure to create an OAuth service:

In the Participants view of a process, create a new Partner Service Provider.

Select System Services from the Interfaces tree.

Select OAuth
.

From the Partner Service Provider that you created, start with the

getAccessToken

operation to create an invoke activity. See the operation descriptions below.

The OAuth operations are as follows:

getAccessToken	Returns an OAuth access token for the given user. An access token is persisted after authorization is complete.
getAuthorizationURL	Returns the authorization URL configured for the OAuth provider. Process Developer maintains this URL for each OAuth provider configuration listed in the PDD. This authorizationURL is invoked by the user (outside of Process Developer), and during this process, the OAuth provider lets the user know that Process Developer is trying to access the account and gets the user's content. Once the user approves the access, the provider returns a verifier string/code to the user. In the case of OAuth2.0, some providers require a redirect URL to which the request is redirected along with verifier string as a request parameter. For providers (usually OAuth2.0 providers) who require a redirect URL, it can be specified in the PDD along with other credentials.
authorize	Takes the verifier string (given by the OAuth provider as a response to the authorizationURL) and authorizes with the OAuth provider. It also stores the OAuth access token returned by provider. This token is used further to access the protected resources on the provider. Once this token is generated, OAuth initial setup workflow is over. This is typically a one-time effort. However, it has to be done once the OAuth access token is expired (its lifetime is decided by OAuth provider).
sendRequest	If the OAuth token for the given OAuth provider and user is present in Process Developer, this operation sends a request to access protected resources on OAuth provider system. This should be preceded by an authorize call, which generates and stores token in Process Developer.