Click or drag to resize

UserSecurityServices Methods

The UserSecurityServices type exposes the following members.

Methods
  NameDescription
Public methodAddPermissionsToRole
Adds security permissions to a security role. All existing permissions for the role are retained, and the resulting permissions will be the union of the existing permissions and the permissions specified by the permissions parameter of this method.
Public methodAddUserCertifications
Adds new operator certifications to the user account specified by the userName parameter. The user's final certification list will be the union of the their existing certifications, and the certifications specified by the newCertifications parameter. If any of the certifications in the newCertifications list are already associated to the user, the effective and expiration dates for those certifications will be updated.
Public methodAddUsersToGroup
Adds multiple pre-existing FactoryLogix user accounts to an existing user group.
Public methodAddUserToGroup
Adds an pre-existing FactoryLogix user account to an pre-existing user group.
Public methodCreateRole
Create a new security role that may be later assigned to users and user groups.
Public methodCreateUser
Creates a new FactoryLogix user account.
Public methodCreateUserGroup
Creates a new FactoryLogix user group.
Public methodDeleteRole
Permanently deletes a seurity role from the system. All users, user groups, and permissions associated to this role will be disassociated from the role, but not be deleted.
Public methodDeleteUser
Permanently removes a particular FactoryLogix user account from the system. All roles, certifications, and other information associated to this acccount will be deleted as well.
Public methodDeleteUserGroup
Permanently removes a particular FactoryLogix user group from the system. All roles, group members, and other information associated to this acccount will be disassociated from the deleted group, but not deleted.
Public methodGetAllCertifications
Retrieves a list of all operator certifications that are known to the system. The certifications returned by this method may or may not be associated to any user accounts, and the effective and expiration date properties will not be populated. The Certification objects returned by this method have a valid Id property, and may be used by subsequent calls to associate certifications to individual users.
Public methodGetAllPermissions
Retrieves a list of all security permissions supported by the FactoryLogix system. These permissions may be associated to security roles, which then may be associated to users and user groups.
Public methodGetAllRoles
Retrieves a single security role definition.
Public methodGetAllUserGroups
Retrieves the details of all FactoryLogix user groups. User groups are collections of individual users who share certain rights, roles, or group email addresses.
Public methodGetAllUsers
Retrieves the details of all FactoryLogix user accounts.
Public methodGetCertification
Retrieves a single operator certification based on the friendly name of the certification. The certification returned by this method may or may not be associated to any user accounts, and the effective and expiration date properties will not be populated. The Certification object returned by this method has a valid Id property, and may be used by subsequent calls to associate certifications to individual users.
Public methodGetRole
Retrieves a single security role definition.
Public methodGetRolePermissions
Retrieves the security permissions associated to the specified security role.
Public methodGetUser
Retrieves the details of a particular FactoryLogix user account.
Public methodGetUserCertifications
Retrieves the operator certifications associated to a single user, as specified by the userName parameter. The Certification objects returned by this method will have valid effective and expiration dates for this individual user.
Public methodGetUserGroup
Retrieves the details of a particular FactoryLogix user group. User groups are collections of individual users who share certain rights, roles, or group email addresses.
Public methodGetUserPermissions
Retrieves the security permissions associated to the specified user.
Public methodRemoveAllUserCertifications
Removes all operator certifications that are associated to the specified user. All effectivity date information for this user-certification association will be permanently deleted.
Public methodRemovePermissionsFromRole
Removes the specified security permissions from a security role. All existing permissions for the role are retained except for the permissions specified. If permissions are specified by the permissions parameter which are not associated to the role, they will be ignored.
Public methodRemoveUserCertifications
Removes the specified operator certifications from specified user. All effectivity date information for this user-certification association will be permanently deleted. If a certification is specified that is not presently associated to the user, it will be ignored.
Public methodRemoveUserFromGroup
Removes a single user from a user group.
Public methodRemoveUsersFromGroup
Removes multiple users from a user group.
Public methodSetRolePermissions
Sets the security permissions for a security role. All existing permissions associated to the role will be removed and replaced by the new list or permissions.
Public methodUpdateRole
Updates an existing security role.
Public methodUpdateUser
Updates the details of a particular FactoryLogix user account.
Public methodUpdateUserGroup
Updates the details of a particular FactoryLogix user group.
Public methodValidateUserPassword
Validates the password of a FactoryLogix user.
Top
See Also