Authorizing data collectors using OAuth
Beginning with Workforce Intelligence 8.5 and Pega Robot Runtime 19.1.63, you can secure Robot Runtime routes, or the API endpoints with which Robot Runtime interacts, using OAuth tokens. For each data collector (user with Robot Runtime installed), a client ID and client secret combination securely authorizes the API endpoints.
Requesting Robot Runtime OAuth credentials
- Log in to My Support Portal.
- On the My Support Portal home page, click > .
- On the Create tab, enter the request information:
- In the Request type field, select Other.
- In the Type field, select Workforce intelligence.
- In the Short description field, enter Requesting Robot Runtime OAuth credentials.
In the Primary application field, enter Workforce Intelligence.
In the Deployment field, select Pega Cloud.
In the Environment field, enter Other.
In the Other URL field, enter the URL of your Workforce Intelligence instance (for example, https://xxxx.wfi.pega.com).
- Click .
On the Details tab, in the Describe what you need assistance with field, enter Provide client ID/secret to enable Robot Runtime authorization.
Click
.- On the Communication preferences tab, review the contact information, and then make any necessary changes or additions.
- Click .
Result: The Workforce Intelligence Service Delivery Team creates an internal ticket with the Pega Workforce Intelligence Cloud team and schedules a meeting to provide you with the Robot Runtime OAuth credentials.
Enabling Runtime authorization (OAuth) for data collectors
After the Workforce Intelligence Service Delivery Team provides the OAuth credentials, complete these steps to enable Robot Runtime OAuth for data collectors.
- In the CommonConfig.xml file, add a wfiOauthEnabled attribute to the Intelligence Server section, and enter true as the value.
Example:
<Server name="Intelligence" baseURL="https://acme.wfi.pega.com" enabled="true" proxyAddress="" wfiOauthEnabled="true"/>
- On local Runtime machines, store the credentials that you received from the Workforce Intelligence Service Delivery Team by using SCCM (System Center Configuration Manager) or a similar console:
- Change the folder location and navigate to C:\Program Files (x86)\Pegasystems\Pega Robot Runtime.
- Run the Pega.WFICredentialsLoader.exe file.
- Send the credentials to the Pega.WFICredentialsLoader.exe file through standard input, using the following examples as a guide. These examples use the pipe character (|), which allows the credentials to be sent to Pega.WFICredentialsLoader.exe. The pipe character is available on your keyboard.
- Send the credentials without referencing a file
echo {"wfiClientId": "runtime-client", "wfiClientSecret": "runtime-secret"} | Pega.WFICredentialsLoader.exe receiveStandardInput - Send the credentials using a file
type credentials.json | Pega.WFICredentialsLoader.exe receiveStandardInput
Previous topic Requesting exports of Workforce Intelligence data Next topic Requesting access to API endpoints