Difference between revisions of "LDAPS User Sync Profile"

From Studentnet Wiki
Jump to navigation Jump to search
Line 27: Line 27:
 
! style="color:black" | Field
 
! style="color:black" | Field
 
! style="color:black" | Description
 
! style="color:black" | Description
! style="color:black" | Active Directory Example
+
! style="color:black" | Active Directory Example if available
 
|-
 
|-
 
|[[Image: usersearchcontainer2.png]]
 
|[[Image: usersearchcontainer2.png]]

Revision as of 01:31, 19 January 2022

Base Settings

Base Settings
Field Description
Userdesc.png A short description to identify the sync profile
Userldapserver.png IP address or host name of the directory server to collect information from. Password reset will only work over LDAPS://
Userldapuser.png Username to bind to when collecting
Userldappassword.png Password to use when collecting information from the server

User Settings

User Settings
Field Description Active Directory Example if available
Usersearchcontainer2.png The qualified name for the container to look for users. eg, OU=students, OU=users, DC=yourdomain, DC=com Usersearchcontainer.png
Userroles.png Users created with this sync profile will have the selected role Roles are assigned by the sync profile so won't be found in AD
Usermailfield.png User attribute containing primary email address Userademail.png
Useraltemail.png Additional email addresses for a user can be imported here
Userupn.png This option will make sure a user's UPN will always be present in the Alternative Addresses for that user
Userusername.png User attribute containing the username Useradusername.png
Userallowemail.png Allows users to have an email address as their username, this may have unexpected side-effects and each email address must be unique
Userguid.png User attribute containing a unique and immutable identifier
Userlastname.png User attribute containing the user's surname Useradlastname.png
Usersisid.png The LDAP attribute that stores the SIS ID for a user. This field is important for Canvas and other services
Userformfeild.png The LDAP attribute that stores Form or Year Group information for students.
Userresetemail.png LDAP Field to look for an email address to use in password reset requests. Setting this field prevents users from configuring their own password reset information.
Userresetmobile.png LDAP Field to look for a mobile number to be used during password requests. Setting this field prevents users from configuring their own password reset information.
Userextraatt.png Anything extra about a user that isn't found elsewhere in this form that you wish to add
Userextrasearch.png LDAP query paramaters that will be be used to further restrict Cloudwork's default user syncing

Advanced Settings

Advanced Settings
Field Description Active Directory Example
Users and Org Units created by this profile will be created under this Org Unit.
When this option is enabled, Cloudwork will not create any of the Org Units in the search container field. Users and sub Org Units will be created directly under the parent Org Unit
When a user is deleted or moved to a location that Cloudwork can't see, Cloudwork will perform the chosen action
The email domain for groups. If Force Mail Domain is selected, user accounts created or updated by replace the email domain with this domain
Cloudwork will use this template to send welcome emails, if the "send Welcome" option is enabled.