Difference between revisions of "LDAPS Group Sync Profile"
Jump to navigation
Jump to search
Jrobertson (talk | contribs) |
Jrobertson (talk | contribs) |
||
| Line 1: | Line 1: | ||
| + | LDAPS User Sync Profiles are used to process users from Active Directory (AD) and put them in the dashboard | ||
| + | ==Minimum requirements for a user to be synced from AD to Cloudwork== | ||
| + | Each user that needs to be synced into Cloudwork require the following attributes in AD: | ||
| + | *Givenname | ||
| + | *Surname | ||
| + | *Samaccountname | ||
| + | *Mail | ||
| + | |||
| + | ==Information and Settings to have ready before creating sync profile== | ||
| + | ===Directory Configuration=== | ||
| + | In your directory: | ||
| + | *Open your firewall and allow IP ranges from [https://wiki.studentnet.net/index.php/IP_Range#Cloudwork_IP_Range here] | ||
| + | *Create a user in your directory which has read permissions and save the following details about newly created user: | ||
| + | **Username: | ||
| + | **Password: | ||
| + | **Directory Location: | ||
| + | *Have the LDAP path for the container you want synced: | ||
| + | *Note down the IP address your directory server is on: | ||
| + | *Note has the mail attribute populated with the user's email address? If not where is this stored? | ||
| + | |||
| + | ==Creating a the LDAP User Sync Profile== | ||
| + | #In the '''Cloudwork Dashboard'''>'''Sync Profile'''>'''New Sync Profile'''>'''LDAP Users Sync Profile''' | ||
| + | #Fill in the form: | ||
| + | #*'''Description''': Name or Description of Sync profile | ||
| + | #*'''Ldap User''': Directory and username of newly created user | ||
| + | #*'''Ldap Password''': Password of newly created user | ||
| + | #*'''Search Container''': The LDAP path for the container you want synced | ||
| + | #*'''Role''': Depending on user type, select the appropriate type of '''Teacher''', '''Student''', '''Alum''', '''Staff''', '''Employee''' or '''Parent''' | ||
| + | #Click submit | ||
| + | |||
== Base Settings == | == Base Settings == | ||
Revision as of 04:56, 2 August 2024
LDAPS User Sync Profiles are used to process users from Active Directory (AD) and put them in the dashboard
Contents
Minimum requirements for a user to be synced from AD to Cloudwork
Each user that needs to be synced into Cloudwork require the following attributes in AD:
- Givenname
- Surname
- Samaccountname
Information and Settings to have ready before creating sync profile
Directory Configuration
In your directory:
- Open your firewall and allow IP ranges from here
- Create a user in your directory which has read permissions and save the following details about newly created user:
- Username:
- Password:
- Directory Location:
- Have the LDAP path for the container you want synced:
- Note down the IP address your directory server is on:
- Note has the mail attribute populated with the user's email address? If not where is this stored?
Creating a the LDAP User Sync Profile
- In the Cloudwork Dashboard>Sync Profile>New Sync Profile>LDAP Users Sync Profile
- Fill in the form:
- Description: Name or Description of Sync profile
- Ldap User: Directory and username of newly created user
- Ldap Password: Password of newly created user
- Search Container: The LDAP path for the container you want synced
- Role: Depending on user type, select the appropriate type of Teacher, Student, Alum, Staff, Employee or Parent
- Click submit
Base Settings
| Field | Description |
|---|---|
|
A short description to identify the sync profile |
|
IP address or host name of the directory server to collect information from. Password reset will only work over LDAPS:// |
|
Username to bind to when collecting |
|
Password to use when collecting information from the server |
Group Settings
| Field | Description | Active Directory Example if available |
|---|---|---|
|
The qualified name for the container to look for users. eg, OU=students, OU=users, DC=yourdomain, DC=com | 
|
| Friendly name for the group | ||
| The field that contains the name of the group | ||
| Default Group Type - this setting decides which users can send to the group | ||
| The LDAP attribute that stores the SIS ID for a group. This field is important for Canvas, and other services. | ||
| Group Faculty Attribute - Not sure | ||
| Group form attribute - not sure | ||
| Email address attribute used to look up group members | ||
| LDAP query paramaters that will be be used to further restrict Cloudwork's default group syncing | ||
| Group types - not sure! |
Advanced Settings
| Field | Description |
|---|---|
|
The email domain for groups. If Force Mail Domain is selected, user accounts created or updated by replace the email domain with this domain |
|
The directory type that the users are syncing from |
|
When a user is deleted or moved to a location that Cloudwork can't see, Cloudwork will perform the chosen action |
