system.user
User Functions
The following functions give you access to view and edit users.
📄️ addCompositeSchedule
Allows two schedules to be combined into a composite schedule.
📄️ addHoliday
Allows a holiday to be added.
📄️ addRole
Adds a role to the specified user source.
📄️ addSchedule
Adds a schedule.
📄️ addUser
Adds a new user to a user source.
📄️ createScheduleAdjustment
Creates a schedule adjustment.
📄️ editHoliday
Allows a holiday to be edited.
📄️ editRole
Renames a role in the specified user source.
📄️ editSchedule
Allows a schedule to be edited.
📄️ editUser
Alters a specific user in a user source, replacing the previous data with the new data passed in.
📄️ getHoliday
Returns a specific holiday.
📄️ getHolidayNames
Returns a collection of Strings of all holiday names.
📄️ getHolidays
Returns a sequence of all of the holidays available.
📄️ getNewUser
Creates a new user object.
📄️ getRoles
Returns a sequence of strings representing all of the roles configured in a specific user source.
📄️ getSchedule
Returns a specific schedule.
📄️ getScheduledUsers
Returns a list of users that are scheduled.
📄️ getScheduleNames
Returns a sequence of strings representing the names of all of the schedules available.
📄️ getSchedules
Returns a sequence of all available schedule models, which can be used to return configuration information on the schedule, such as time for each day of the week.
📄️ getUser
Looks up a specific user in a user source, by username.
📄️ getUsers
Retrieves the list of users in a specific user source.
📄️ getUserSources
Returns a sequence of objects representing all of the user source profiles configured in the Gateway.
📄️ isUserScheduled
Will check if a specified User is scheduled currently or on a specified date/time.
📄️ removeHoliday
Allows a holiday to be deleted.
📄️ removeRole
Removes a role from the specified user source.
📄️ removeSchedule
Allows a schedule to be deleted.
📄️ removeUser
Removes a specific user from the a user source based on username.
Functions by Scope
- addCompositeSchedule
- addHoliday
- addRole
- addSchedule
- addUser
- createScheduleAdjustment
- editHoliday
- editRole
- editSchedule
- editUser
- getHoliday
- getHolidayNames
- getHolidays
- getNewUser
- getRoles
- getSchedule
- getScheduleNames
- getScheduledUsers
- getSchedules
- getUser
- getUserSources
- getUsers
- isUserScheduled
- removeHoliday
- removeRole
- removeSchedule
- removeUser
- addCompositeSchedule
- addHoliday
- addRole
- addSchedule
- addUser
- createScheduleAdjustment
- editHoliday
- editRole
- editSchedule
- editUser
- getHoliday
- getHolidayNames
- getHolidays
- getNewUser
- getRoles
- getSchedule
- getScheduleNames
- getScheduledUsers
- getSchedules
- getUser
- getUserSources
- getUsers
- isUserScheduled
- removeHoliday
- removeRole
- removeSchedule
- removeUser
- addCompositeSchedule
- addHoliday
- addRole
- addSchedule
- addUser
- createScheduleAdjustment
- editHoliday
- editRole
- editSchedule
- editUser
- getHoliday
- getHolidayNames
- getHolidays
- getNewUser
- getRoles
- getSchedule
- getScheduleNames
- getScheduledUsers
- getSchedules
- getUser
- getUserSources
- getUsers
- isUserScheduled
- removeHoliday
- removeRole
- removeSchedule
- removeUser