You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/user-manual/sign_sync.md
+66-22Lines changed: 66 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -202,7 +202,7 @@ user_management:
202
202
203
203
**`logging`**
204
204
205
-
The logging options in `sync-sync-config.yml` are identical to the logging options in `user-sync-config.yml`.
205
+
The logging options in `sign-sync-config.yml` are identical to the logging options in `user-sync-config.yml`.
206
206
207
207
```yaml
208
208
logging:
@@ -267,6 +267,71 @@ For the Sign connector, the user or account in the OS keychain should be the adm
267
267
The `integration_key` config key should not be specified. The reference to the OS keychain credential is specified in
268
268
`secure_integration_key_key`.
269
269
270
+
# Use Cases
271
+
272
+
## Sign Enterprise
273
+
274
+
Admin Consoles with a Sign Enterprise plan do not need to use the Sync Tool for basic Sign user provisioning. Users
275
+
assigned to a Sign Enterprise product profile will be automatically provisioned to the Default Group with
276
+
normal user privileges.
277
+
278
+
The Admin Console UI can manage account admin status, but cannot manage Sign groups or group admin status. However,
279
+
the User Management API does not allow management of admin account status via the Admin Console. The Sign Sync Connector
280
+
can manage group assignments, group admin status and account admin status directly in Sign.
281
+
282
+
### Upstream User Sync
283
+
284
+
The Sign Sync Connector will not sync users to the Admin Console. Users can be provisioned to the Admin Console in a
285
+
variety of ways.
286
+
287
+
* Manually in the Admin Console UI
288
+
* User Sync Tool in Admin Console Sync mode (`./user-sync` or `./user-sync sync`)
289
+
* Azure AD Sync
290
+
* Google Sync
291
+
* CSV Bulk Upload
292
+
* Using the User Management API directly
293
+
294
+
In any case, to manage Sign Enterprise users, you should use the `adobe_console` [identity connector](advanced_configuration.md#the-admin-console-connector).
295
+
296
+
### Using Sign Sync with Admin Console Sync
297
+
298
+
If you already use the User Sync Tool to synchronize users to the Adobe Admin Console, all you need to do is ensure
299
+
that you have a group mapping to entitle Sign Enterprise users. Then, when your Sign Sync config is set up, just invoke
300
+
Sign Sync after the main Admin Console Sync completes. We recommend using a batch file or shell script to run
301
+
the two sync processes in sequence.
302
+
303
+
Windows batch example:
304
+
305
+
```
306
+
mode 155,50
307
+
cd /D "%~dp0"
308
+
309
+
REM Run main sync to Admin Console
310
+
user-sync.exe
311
+
312
+
REM Run Sign Sync
313
+
user-sync.exe sign-sync
314
+
```
315
+
316
+
Bash example:
317
+
318
+
```sh
319
+
#!/bin/sh
320
+
321
+
# Run main sync to Admin Console
322
+
./user-sync
323
+
324
+
# Run Sign Sync
325
+
./user-sync sign-sync
326
+
```
327
+
328
+
## Standalone Sign
329
+
330
+
To manage Sign users for standalone Sign accounts, it is generally recommended to enable the `create_users` and `deactivate_users`
331
+
options in `connector-sign.yml`. This ensures the sync tool can manage the full user lifecycle.
332
+
333
+
And while any Sign-only-user option is valid, `deactivate` is generally the best choice for standalone Sign user management.
334
+
270
335
# API Key Setup
271
336
272
337
Any Sign connection defined in `connector-sign.yml` must specify an integration key for authenticating Sign API calls. New keys
@@ -286,24 +351,3 @@ can be created by an Admin user for a given Sign account.
286
351
8. Click "Integration Key" to display the integration key. This is used in the Sign Sync connector config file.
287
352
288
353

289
-
290
-
# Native Sign to Admin Console Connection
291
-
292
-
The Adobe Sign Sync connector is not required to provision users to Adobe Sign. Users assigned to Sign Enterprise plans
293
-
are automatically granted basic Sign accounts when they are first provisioned to a Sign product profile in the
294
-
Admin Console. When Sign users are created in this manner, they are assigned to the **Default Group** in Sign
295
-
and are assigned **Normal User** privileges.
296
-
297
-
Taking advantage of this native sync functionality with the User Sync Tool is easy - just target an Adobe Sign
298
-
product profile in your group mapping in `user-sync-config.yml`.
299
-
300
-
```yaml
301
-
directory_users:
302
-
groups:
303
-
- directory_group: adobe-sign-enterprise
304
-
adobe_groups:
305
-
- Adobe Sign
306
-
```
307
-
308
-
Updates to user information (First Name, Last Name, and email address) are automatically synced to Sign
0 commit comments