Accredo > File > Web Service > Clients
View and add details for a web client. The client is an app connecting to the server.
Add a new client ID for each service accessing the Web Service. This ensures separation and allows a client ID to be revoked if required without impacting other services.
Where the Web Service module is licensed, Accredo creates the Accredo WebApp, Accredo WinApp and Accredo Ace clients at system login. Accredo also maintains the Internal Tool client. For these clients the Client ID is masked and the client cannot be deleted. Only Session Limit, OTP Options and Create Refresh Tokens can be changed.
Toolbar |
||
Web Client |
Select the Client ID. |
|
Client Name |
Displays the client name. (Read-only) |
|
|
Expand Toolbar |
Expand the toolbar to give access to all toolbar options. Press |
|
Edit |
Enter edit mode, to edit the client details. |
|
Insert |
Click to add a new web client. |
|
Delete |
Delete the web client. |
|
Send Provisioning Emails |
Opens Send Provisioning Emails for the selected Web Service Client. You can send a provisioning email to System Users to assist them in setting up Web Service Clients. |
|
Add Mobile App |
Select Accredo Sales or Accredo Stock to add a client for that app. Completes the defaults for the selected app in the form. Each app can have only one client. |
|
Promote Mobile App |
Gives a mobile app client added in an earlier release the Sales app or Stock app profile, so that Accredo Ace features work with the app. The Client ID and Client Secret do not change, so installed devices continue to sign in. Available when the selected client has the Native app profile, its Client Name is Accredo Sales or Accredo Stock, and no other client has the profile for that app. |
Details |
||
Client ID |
The unique Web Service Client ID. This will be auto-assigned and cannot be edited. |
|
Client Name |
Name of the client. |
|
Client Type |
Select from:
|
|
Client Profile |
Select from:
Accredo sets the Web app, Desktop app and AI assistant profiles. Add Mobile App and Promote Mobile App set the Sales app and Stock app profiles. Client Profile cannot be changed for a client with one of these profiles. |
|
Grant Type |
How the app obtains an Access Token. Select from:
For the Web app client, Grant Type cannot be changed from Password, because the Accredo WebApp signs in only with the Password grant type. |
|
Client Secret |
For the Client Credentials grant type only. Accredo creates a secret when you select Client Credentials on a new client. Accredo stores only a one-way hash of the secret, so the secret displays only until you save. After that the field shows (secret set). Click Click |
|
User Code |
For the Client Credentials grant type only, and required for it. The System User the app acts as. |
|
Password |
For the Client Credentials grant type only, and required for it. The password of the User Code. Click |
|
Session Limit |
The maximum number of Access Tokens the Web Client may obtain. |
|
Inactive |
Selected, the token will be made inactive. |
|
Redirect URLs |
For the Authorisation Code grant type only. The URLs the web browser may return to after the user signs in, one per line. |
|
OTP Options |
||
OTP Enabled |
Selected, logins will require OTP. Available only when One-time password enabled is Selected on System Settings - Passwords tab. A new client takes its default from that setting. Recommended: Selected for the Accredo WebApp client and the mobile app clients, with an OTP Prompt Interval ... days set. See the Accredo passwords and one-time password video, and the ACSC guide to strong passwords. |
|
OTP Prompt Interval ... days |
The number of days between OTP requirement. 0 means OTP is required for every login. Available only when OTP Enabled is Selected. |
|
Create Refresh Tokens |
Selected, a Refresh Token will be created when an Access Token is obtained. Unselected, Refresh Tokens are not created. If OTP Enabled is Selected and OTP Prompt Interval is 0 then Create Refresh Tokens should be Unselected. |
|
URL |
||
If the following URLs are entered, they will be included if a Provisioning Email is sent. Click Click Click
|
||
Web URL |
URL for the company website. |
|
Android Play Store URL |
Android Play Store URL for the app. This will be included on the provisioning email. |
|
Android App Link URL |
Android URL to set up the app. This will be included on the provisioning email. |
|
IOS App Store URL |
IOS iTunes URL for the app. This will be included on the provisioning email. |
|
IOS App Link URL |
IOS iTunes URL to set up the app. This will be included on the provisioning email. |
|