Previous Topic

Next Topic

Web Clients

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)

ToolbarExpand

Expand Toolbar (Alt+F9)

Expand the toolbar to give access to all toolbar options. Press ESC to close the expanded toolbar.

Edit (F11)

Enter edit mode, to edit the client details.

Insert (F4)

Click to add a new web client.

Delete (F3)

Delete the web client.

EmailDesigner

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.

AppProvisioning

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.

UpgradeTable

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:

  • Public - the app does not keep the client password confidential. Use for situations where the password is embedded, such as mobile phones.
  • Confidential - the app keeps the client password confidential.

Client Profile

Select from:

  • Server-side web app - the app is running on a web server.
  • Client-side app - the app is running on a user agent, such as a web browser.
  • Native app - the app is running on a device such as a mobile phone or desktop, and is installed on the device, so the password is also stored on the device.
  • Web app - the Accredo WebApp client.
  • Desktop app - the Accredo WinApp client. The desktop application uses it to call the web service as the logged-in user, in that user's companies. Web service sessions for this client do not use a Web Sessions licence.
  • AI assistant - the Accredo Ace client.
  • Sales app - the Accredo Sales mobile app client.
  • Stock app - the Accredo Stock mobile app client.

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:

  • Authorisation Code - the user signs in through a web browser, which then returns to one of the Redirect URLs.
  • Client Credentials - the app signs in with the Client ID and Client Secret, and acts as the User Code entered for the client.
  • Password - the app signs in with the user's own user code and password. The Accredo WebApp and the mobile apps use this grant type.
  • Device Code - the user approves the sign in on a second device.

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 Copy Client Secret to copy a new secret to the clipboard. Copy it before you save.

Click RefreshFromSource Regenerate Client Secret in edit mode to replace the secret. After you save, an app that uses the old secret cannot sign in.

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 ScriptCheck Test User and Password to check that the User Code and Password are valid and that the user is allowed web sessions.

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 Visit web site (Ctrl+W) beside a URL to go to the website.

Click ShareQRCode beside a URL to display a QR code to scan for the website.

Click beside a URL to print the QR code for the website.

 

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.

In This Section

Send Provisioning Emails

See Also

Web Service Menu

Book Contents

Book Index