diff --git a/_articles/directory-connector/directory-sync.md b/_articles/directory-connector/directory-sync.md index 931ea97d..c3f5302a 100644 --- a/_articles/directory-connector/directory-sync.md +++ b/_articles/directory-connector/directory-sync.md @@ -63,12 +63,14 @@ Console.exe login -e -p [-t] [-o] ``` {% table %} + | Description | Argument | Example Value | Required | |-----------------|----------|--------------------------------------|----------| | Email | -e | user@example.com | y | | Password | -p | mypassword123 | y | | 2FA Token | -t | 381119 | n | | Organization Id | -o | acadad98-b666-498d-b89f-f220f21e453f | n | + {% endtable %} You can also log out with the following command: @@ -94,35 +96,42 @@ Console.exe configdir -t [azure: -i -s -te] [gsuite: -f -u [-d] [-c]] [ad/ldap: ``` {% table %} + | Description | Argument | Example Value | Required | Notes | |-----------------|----------|--------------------------------------|----------|------------------------------------------| | Type | -t | 1 | y | AD = 0, Azure = 1, Other = 2, GSuite = 3 | + {% endtable %} #### Azure {% table %} + | Description | Argument | Example Value | Required | |----------------|----------|--------------------------------------|----------| | Application Id | -i | 0f82b419-c5b3-4b63-8afc-67d240da85a6 | y | | Secret Key | -s | c2VjcmV0X2tleQ== | y | | Tenant | -te | mycompany.onmicrosoft.com | y | + {% endtable %} #### G Suite {% table %} + | Description | Argument | Example Value | Required | |-------------|----------|--------------------|----------| | Secret File | -f | client_secret.json | y | | Admin User | -u | admin@company.com | y | | Domain | -d | company.com | y | | Customer Id | -c | 39204722352 | n | + {% endtable %} #### Active Directory / Other LDAP {% table %} + | Description | Argument | Example Value | Required | |--------------|----------|---------------------|----------| | Address | -a | company.local | y | @@ -131,6 +140,7 @@ Console.exe configdir -t [azure: -i -s -te] [gsuite: -f -u [-d] [-c]] [ad/ldap: | Current User | -cu | n/a | n | | Username | -u | admin@company.com | n | | Password | -p | mypassword | n | + {% endtable %} {% note %} @@ -150,6 +160,7 @@ Console.exe configsync [-g] [-u] [-i] [-uf] [-gf] [-rd] [ad/ldap: [-go] [-gp] [- ``` {% table %} + | Description | Argument | Example Value | Required | Notes | |-----------------|----------|------------------------|----------|----------------------------------------------------| | Sync Groups | -g | n/a | n | | @@ -158,6 +169,7 @@ Console.exe configsync [-g] [-u] [-i] [-uf] [-gf] [-rd] [ad/ldap: [-go] [-gp] [- | User Filter | -uf | (&(objectClass=user)) | n | Value syntax is different for each directory type. | | Group Filter | -gf | (&(objectClass=group)) | n | Value syntax is different for each directory type. | | Remove Disabled | -rd | n/a | n | | + {% endtable %} {% note %} @@ -169,6 +181,7 @@ The syntax for user and group filters is different for each type of directory. L #### Active Directory / Other LDAP {% table %} + | Description | Argument | Example Value | Required | |-------------------------|----------|----------------|----------| | Group Object Class | -go | group | y | @@ -183,6 +196,7 @@ The syntax for user and group filters is different for each type of directory. L | Email Suffix | -es | @company.com | n | | Creation Date Attribute | -c | whenCreated | n | | Revision Date Attribute | -r | whenChanged | n | + {% endtable %} ### Manually simulate a sync @@ -200,9 +214,11 @@ Console.exe sim [-f] ``` {% table %} + | Description | Argument | Example Value | Required | Notes | |-------------|----------|---------------|----------|---------------------| | Force | -f | n/a | n | Forces a full sync. | + {% endtable %} ### Perform a sync @@ -217,9 +233,11 @@ Console.exe sync [-f] ``` {% table %} + | Description | Argument | Example Value | Required | Notes | |-------------|----------|---------------|----------|---------------------| | Force | -f | n/a | n | Forces a full sync. | + {% endtable %} ### Manage the background service @@ -237,10 +255,12 @@ Console.exe service [-start] [-stop] ``` {% table %} + | Description | Argument | Example Value | Required | |-------------|----------|---------------|----------| | Start | -start | n/a | n | | Stop | -stop | n/a | n | + {% endtable %} {% note %} diff --git a/_articles/directory-connector/ldap-directory.md b/_articles/directory-connector/ldap-directory.md index 5c74d66a..4e49adb4 100644 --- a/_articles/directory-connector/ldap-directory.md +++ b/_articles/directory-connector/ldap-directory.md @@ -36,6 +36,7 @@ We provide built-in connectors for the most popular LDAP directory servers, such The following options can be set: {% table %} + | Property | Description | Examples | |----------|-------------|----------| | Address | The host name of your directory server. | `ad.company.com` or `ldap.company.local` | @@ -44,6 +45,7 @@ The following options can be set: | Current user | Authenticate to the directory server as the currently logged in user. For Active Directory, the user should be a member of the built-in administrators group. | | | Username | The distinguished name of an administrative user that the application will use when connecting to the directory server. For Active Directory, the user should be a member of the built-in administrators group. | `cn=admin,cn=users,dc=ad,dc=company,dc=com` or `admin@company.com` | | Password | The password of the user specified above. Note that the password is safely encrypted before being stored for the application, however, to better guarantee its security, you should ensure that other processes do not have OS-level read permissions for this application's settings files. | | + {% endtable %} ## Configuring Sync Settings @@ -53,6 +55,7 @@ The following options can be set: 3. Step through and set each sync configuration setting. {% table %} + | Property | Description | Examples | |----------|---------- --|----------| | Sync Groups | Sync groups to your organization. | | @@ -73,4 +76,5 @@ The following options can be set: | Email Suffix | The specified suffix to use when forming a user's email address from the prefix/suffix setting. | @company.com | | Creation Date Attribute | The attribute field that specifies when an entry was created. | whenCreated | | Revision Date Attribute | The attribute field that specifies when an entry was changed. | whenChanged | + {% endtable %}