User Guide > Process Steps and Components > Invoker Step > OAuth 2.0 Invoker
Was this helpful?
OAuth 2.0 Invoker
The OAuth 2.0 Invoker component enables OAuth Authorization using an invoker which inserts an access token into a DJMessage body within a Process workflow. This feature relieves the user from having to manually retrieve an access token.
The OAuth 2.0 Invoker supports the following Grant Types: Client Credentials Grant, Password Credentials Grant and Refresh Token.
Property Name
Description
Authorization Server URL
The host URL for requesting OAuth Authorization.
Authorization Grant Type
The Grant Type to use for OAuth Authorization. Options available are:
• Client Credentials Grant - This option requires a Client ID and Client Secret.
• Password Credentials Grant - This option requires a Username and Password.
• Refresh Token - This option requires a Refresh Token.
Credentials in Request Body
Specifies whether client credentials are sent in the request body, or through a Basic Auth header. By default, credentials are sent through a Basic Auth header.
• TRUE: Credentials are sent through the request body.
• FALSE (default): Credentials are sent through a Basic Auth Header.
Client ID
The Client ID associated with the resource owner.
Client Secret
The Client Secret associated with the resource owner.
Scope
The scope to be set for OAuth Authorization.
Username
User ID to access the resource.
Password
Password to access the resource.
Refresh Token
ID which provides user with a new access token when their current token expires.
Supported Actions and Parameters
Action
Parameter
Description
Execute
 
Executes the supported properties to perform authentication. The server response will be returned in the Target DJMessage.
 
TargetMessage
Set this parameter to write the server response to a target DJMessage.
Note:  After a successful request, the access token can be found under DJMOUT.AccessToken, along with other server response properties under DJMOUT.PropertyNames(n).
Error Codes
Code
Description
Reason
4
Invalid error
Error by Server while requesting access token.
46
License error
The OAuth 2.0 Invoker is not licensed or has an expired license.
Last modified date: 10/22/2024