What is an Authentication object and how do I configure it?
Authentication objects are used to hold sensitive login details which are required to connect to third party systems.
They will provide fresh tokens via one way encryption to API Actors without giving users access to this sensitive data.
One authentication object can be used in multiple API Calls. Holding the data in one central location, then pulling on this in the system areas where it is required, allows for easy management of the "account" details.
Supported providers
Authentication objects can be configured for the following providers:
- Autologyx internal
- DocuSign
- API Key
- Adobe oAuth 2.0 (Client Credentials flow)
- Box oAuth 2.0 (Client Credentials flow)
- Generic oAuth 2.0 (Client Credentials flow)
- Generic oAuth 2.0 (ROPC Grant flow)
- iManage oAuth 2.0 (Password Grant flow)
Configure an Authentication object
To configure an Authentication object, you will require not only the appropriate role permissions in Autologyx, but also access to technical information pertaining to the relevant provider.
To begin
Go to Administration in the main navigation menu. Click on Authentication objects. You will be taken to the Authentication objects list.
Click the + Create button on the top left hand side of the list.
A maximum of 100 Authentication objects can be configured in your system. If the limit is reached, the + Create button will be disabled.
Enter the object details
Give the Authentication object a unique, descriptive name as this is how you will recognise the authentication object when selecting it in an API call.
The Description isn't mandatory, but it can be useful to describe who/what the object is to be used for, as this field appears in the Authentication object list. You'll note that there is a 500 character limit.
Set an expiry date to make it easier to track and renew credentials before they expire. Tick the box next to Set expiry date, select a date and state what the expiry applies to.
Additionally, you can configure automated notifications through the Sequencer to send email reminders as the expiration date approaches.
Select the provider
Select the required Provider.
Having done that, further fields will be displayed. These will change depending on the provider selected, but they will all be mandatory.
Validation and testing
There is some built-in validation that prevents saving in certain cases - for example, the Name field must be unique, and the URL field must follow a specific format, as shown below.
If the system detects that the credentials entered are not valid and an error is shown, the Save button will remain disabled.
The Test authentication object button will remain disabled until all mandatory fields have been completed without error. However, if the test fails, the below toast message will be displayed.
If you enter valid credentials and the Authentication object is saved, you will be returned to the Authentication object list. You will also see a green coloured toast message which will confirm that the object has been saved.
Useful info
- The maximum number of Authentication objects you can have in your system is 100.