Skip to main content
The first time that you launch , the application prompts you to create the first application user (with username and password credentials).
The first user that you create defaults to the Admin role because this role has full control over the application. See Roles for more information about built-in (predefined) and custom roles.

​
Viewing Your User Accounts

You can view a list of all your user accounts (or, users) from the Users tab on the Settings page. The table on this page summarizes your users and enables you to manage those accounts from one access point. Users table on the Settings page The users are displayed in rows, with columns that provide details about each user. As shown above, you can specify the number of rows that you want to display on the page by selecting a number from the X records per page list at the bottom of the page. information about user accounts in these four columns:
  • NAME—Shows the user’s name and role.
  • STATUS—Indicates whether the user is active or inactive.
  • TWO-FACTOR AUTHENTICATION—Specifies whether two-factor authentication is enabled for the user account.
  • CREATED—Shows the date and timed when the user account was created.
If you click a user name, opens the Edit User dialog box where you can make changes to the user settings. You can organize your user list in ascending or descending order for the NAME, STATUS, TWO-FACTOR AUTHENTICATION, and CREATED columns. To order the columns, simply click the up (↑) and down (↓) arrows next to the column by which you want to sort. In addition, you can filter the table by role type and status. also enables you to save filters that you define so that you can use them later. Unlike other pages, the Users page does not allow you to reset or save filter options. The only way you can clear a filter and return to the full Users table is to refresh the page from your browser bar.

​
Adding a User

To add a user:
  1. Select Settings > Users to open the Users tab page.
  2. Click Add User to open the Add User dialog box.
  3. Configure the following properties:
    • User Name—Enter the user name.
    • Email Address—(Optional) Add the user’s email address.
    • Password—(Optional) Enter a password for the account
    • Roles—(Optional) Select a role from the drop-down list. You can also add one or more roles by clicking the Add Role button below the Role property.
    • Federation Id—(Optional) Enter a federation identity only if you are using single sign-on.
    • Options—Select the API Access checkbox if you want to access the REST API. When you select this checkbox, an Authtoken text box is displayed that contains an authentication (auth) token. To generate a different auth token, click the Refresh icon (Refresh icon).
    • Active—Select this checkbox to activate the user.
  4. Click Add User to create the user and close the dialog box. Once the dialog box closes, the new user appears in the Users table.

​
Managing User Settings

From the Users table, you can edit user settings or delete a user by clicking the options menu (…) at the end of a user row. User options menu with Edit and Delete options Selecting Edit opens the Edit User dialog box, where you can change any of the current settings. Selecting Delete permanently removes a user account.

​
Creating Users on External Java Servlets

When is deployed to an external servlet (that is, is not using the embedded server that is included), additional Java Authentication and Authorization Service (JAAS) configuration is required to enable to create users dynamically within the application. For more information about JAAS configuration for specific Java servlets, see Deploying CData Sync to External Servlets.

​
API Access

Each user can be granted an auth token that enables access to the API. For more information about authenticating against the API, see Authentication. The specific actions that a user can perform via the API mirrors the actions that the same user can perform via the UI. For example, a user that cannot delete connections via the UI cannot use the API to delete connections. To perform any arbitrary action via the API, use an auth token from an Admin user when you invoke the API.

​
Resetting Passwords

If you forget your password, you can reset it directly from the login page.
  1. On the login screen, click Forgot Password.
  2. Enter your username and click Submit. You should receive the following message: Password reset confirmation message Click Done to exit the dialog box.
  3. Check your inbox for an email from that includes a password reset link.
  4. Click the link in the email to open the Reset Password page.
  5. Enter a new password and save your changes.
After you reset your password, the link in the email expires automatically for security purposes. If you do not receive the email within a few minutes, check your Spam or Junk folder.
  • Passwords are never sent by email. The reset link is secure and valid for a limited time.
  • If you do not receive the email with a reset link, contact your system administrator. The Forgot Password feature is available only when the administrator configures the email server and adds email addresses for existing users.
  • Administrators can also generate a password reset link manually by submitting the following command: 
    java -jar sync.jar -generate-reset-password-link -user <Username>