Introduction

This section describes how to set up a connection to your Zivver organization, configure 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 must connect over port 443 to the Zivver API https://app.zivver.com/api/ while authenticating with an API key.

Click Test connection to test whether the Synctool can connect to https://app.zivver.com/api/ over port 443.

Warning

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.

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

1. Log in to the Zivver WebApp.
2. Click Organization Settings.
3. Expand Integrations.
4. Click API keys.
5. Click New API key.
6. Enter a Description.
   For example: Synctool <admin email address>. This way you know the API key is used for the Synctool and who created it.
7. Click Add.
   The API key is displayed. Make sure to store it somewhere safe, because it will only be shown once and is a powerful key.
8. Click Copy key.
9. In the Synctool, paste the API key in the API-key field.
10. Check the API key for leading or trailing spaces.

Note

Language settings
The API key is linked to the admin who created it. Therefore, personal accounts created with this API key will inherit the same language settings as that admin. For an admin with English language settings, this means accounts will also use English, and the default notification messages will be in English.
Check or change your language settings here

Warning

Administrator out of service
API keys belonging to deleted administrator accounts are no longer valid. However, API keys from suspended admin accounts remain valid and can still be used to create accounts. You may still want to replace such an API key to ensure that user or functional accounts are not created under suspended 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 for users to log in to Zivver.

Deselect Users log in via SSO if your organization does not use Single Sign-On. If Users log in via SSO is unchecked, users are created with a temporary password that you must share with them before their first login. Each new user will set their own password after entering the temporary password created by the Synctool.

Note

Configure Single Sign-On before running the Synctool
If you enable Users log in via SSO, make sure to configure Single Sign-On before running the Synctool.

Target Filter

The target filter allows you to select a specific subset of accounts in your Zivver organization (the target).

You can use a positive filter to include only a subset of accounts, or a negative filter to exclude specific accounts from synchronization.

Tip

External IT suppliers
Use the target filter to prevent administrator accounts from external IT suppliers from being suspended, or to exclude accounts from 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 selected attribute.
   For example: john.doe@example.com. Add each email address on a separate line if you want to add multiple addresses.
4. Apply either as a positive or negative filter.
   If you want to exclude an email address from synchronization, leave Apply as positive filter (include in selection upon match) unchecked. Check it if you want to include an address.

Data Preview

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

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

Click Load the data now to generate a data preview.

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

Warning

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.