06. Synctool Target (Zivver)

Introduction

This section describes how to set up a connection to your Zivver organization, set a filter and view all users and groups in your current Zivver organization. These functions are grouped under the Target (Zivver) tab in the Synctool user interface.

Connect the Synctool to your Zivver organization

To set up a connection from the Synctool to your Zivver organization, the Synctool needs to connect over port 443 to the Zivver API https://app.zivver.com/api/ while authenticating with an API-key.

Click Test Connection to test if the Synctool is allowed to connect to https:app.zivver.com/api/ over port 443.

If you haven’t created an API-key for the Synctool yet, then follow the steps below to create an API-key.

  1. Go to the API Keys page.
  2. At the API Keys page, click GENERATE.
    The Add a new API key pop-up appears.
  3. Fill in a name.
    For example: Synctool {admin email address}. This way you know the API key is used for the Synctool and who created the API key.
  4. Click ADD.
    The API key is shown. Make sure to store it somewhere safe, because the API key will only be shown once and is a powerful key.
  5. Copy the API key file_copy .
  6. In the Synctool, paste the API key in the API-key field.
  7. Check the API key for leading or trailing spaces.
Language settings
The API key is linked to the admin who created the API key. Therefore personal accounts created with this API key will have the same language settings as the admin who created the API key. For an admin with English language settings, this means the accounts created will have English language settings and the notification message default will also be English.
Check or change your language settings here
Administrator out of service
API keys of deleted administrator accounts are no longer valid. By contrast, API keys of disabled admin accounts are still valid and can be used to create accounts. However, you might still want to change the API key, so that user or functional accounts are not created by disabled administrator accounts.
Create a new API key

User login method into Zivver

Keep Users log in via SSO checked if your organization uses Single Sign-On to log users into Zivver.

Uncheck Users log in via SSO if your organization does not use Single Sign-On to log users into Zivver. If Users log in via SSO is unchecked then users are created with a temporary password that you need to communicate to users before their first login attempt. A newly created user will create their own password after he fills in his temporary password created by the Synctool.

Configure Single Sign-On before running the Synctool
If you choose Users log in via SSO, configure Single Sign-On before you run the Synctool.

Target Filter

The target filter allows you to filter on a specific subset of your accounts in Zivver (i.e. the target).

With the target filter you can either use the positive filter to request only a subset of accounts from your Zivver organization, or you can use the negative filter to exclude a subset of accounts from your Zivver organization from the synchronization.

External IT suppliers
Use the target filter to prevent administrator accounts from external IT suppliers from being disabled, or to exclude accounts in other managed domains.
  1. Select Apply filter on users/groups.
  2. At Filter field, select the attribute you want to filter on.
    For example: User email address.
  3. At Filter values, enter the values that match the attribute chosen at the previous step.
    For example: john.doe@example.com. Add each email address on a separate row if you want to add more addresses.
  4. Apply either as a positive or negative filter.
    If you want to exclude an email address from the synchronisation process, leave Apply as positive filter unchecked. Check Apply as positive filter if you want to include an email address from the synchronisation process

Data Preview

The data preview shows you the current situation for users and functional accounts in your Zivver organization.

If you have configured a target filter, then accounts listed in a negative filter are not shown in the data preview.

Click Load the data now to get a data preview.

All users and functional accounts will be shown with their properties in the data preview table.

ERROR
You are not authorized to get Users from the Zivver-API. Did you enter the correct API-key?

This error means the API-key is missing, incomplete, has leading or trailing spaces or has been deprecated. Fix the API-key first or create a new API-key.

Was this article helpful?

thumb_up thumb_down