- Introduction
- Model
- Administer
- Using
- Develop
Authentication
Use Authentication when your system requires access to external REST services.An authentication calledApplication Service Credentials is already created for use within Process Automation. The authentication can be used when you create radio buttons or dropdown lists on your forms. The authentication is selected from theAuthentication dropdown list, accessed from:Field Editor > Advanced > REST Service > Authentication. The authentication it uses is the same as the authentication assigned to the script runtime user.
Note: The nameApplication Service Credentials cannot be used for one of your own authentications because it is reserved.
Properties
The basic properties of creating authentication are:
| Property | Description |
|---|---|
| Authentication name | Required. The name used to identify the authentication. The name must be in lowercase and be between one and 26 characters in length, for exampletoken1auth. |
| Authentication description | Optional. A description of the authentication, for exampleBasic authentication used. |
| Authentication type | Required. Select the type of authentication, for exampleBasic. There are three types of authentication you can use,Basic,Client credentials, andBearer token. |
| Secured | Optional. When selected, credentials are defined during deployment time, or de-select the checkbox to provide them during modeling time. These credentials are used when contacting the external API. |
| Clientid | Required. When using Client credentials authentication, enter the client id, for exampleClient-1. |
| Client secret | Required. When using Client credentials authentication, enter the client secret for the API, for exampleclient.secret. |
| Endpoint | Required. When using Client credentials authentication, enter the end point of the server, for exampleclient.endpoint. The endpoint entered is validated before you can save the authentication. |
| Scope | Required. When using Client credentials authentication, enter one or more scope values that make up part of the API account you want to access, for exampleapi.account.one. The scope entered is validated before you can save the authentication. |
| Token | Required. When using Bearer token authentication, enter the bearer token for the API, for examplebearer-token. |
Note
All the configuration parameters can be overridden at deployment time.
Create authentication
To create authentication:
Sign into the Modeling Application and open a project.
Click the+ next to Authentications.
Enter a name for the authentication.
Optionally, enter a description for the authentication.
Select an authentication type from the dropdown list.
Optionally, deselectSecured so you can enter a username and password that is used when contacting the API.
Authentication
The following is an authentication created using Basic authentication and a username and password.
Upgrade authentication for deployed application
You can upgrade the authentication of your deployed application.
To upgrade your authentication:
Expand theDevops section on the left of the Admin App and then selectApplication Instances.
For the application you want to upgrade, click the three dots on the right of the last column and then selectUpgrade.
Select the version you want to upgrade to from theUpgrade dropdown list.
If you select a version of the application that is identical to the currently deployed one, you will optionally be able to change the configuration values further in this process. If you select a different version of the application that does not have the same configuration values as the currently deployed one, you will be forced to re-enter the authentication values for that application further in this process.
If you want users to receive an email each time a process assigns them a task, selectEnable user task mail notifications and then select theAuthentications tab.
SelectChange the authentication values to change the current authentication values and then clickUpgrade.
If you are upgrading to a different version of the application to the currently deployed one, theChange the authentication values check box will not be visible. Instead, you will be required to re-enter the authentication values of the authentication assigned to the version of the application you are upgrading to.
ClickUpgrade.
Important: For your authentications that are not secure, in other words you did not select theSecured check box when the authentication was created, the configuration values already set in the Modeling Application will be automatically applied during the upgrade process. For your authentications that are secure, in other words you did select theSecured check box when the authentication was created, you must must re-enter the authentication values on theAuthentications tab when performing the upgrade.
Delete authentication
To delete an authentication:
Sign into the Modeling App and open the project that contains the authentication you want to delete.
Expand theAuthentications section on the left.
Select the authentication you want to delete.
Click the three dots and then selectDelete.
You will seeDeleting the authentication may affect your project if this authentication is already in use. ClickConfirm if you still want to delete the authentication.