Role Methods
| Method | Description |
|---|---|
| getRole | Gets a role from the system.
If the role is not found, a value of null is returned. Roles are the rights that give users access to the system. |
| retrieveAllRoles | Retrieves all roles from the system as an array of roles.
The last element of the array is null. If no roles are found, an array of one element is returned with a value of null. |
| retrieveAllRolesForUser | Retrieves all roles that are assigned to a user, and returns an array of roles.
The last element of the array is null. If no roles are found, an array of one element is returned with a value of null. |
| retrieveAllUsersInRole | Retrieves all users that have been assigned to a role, and returns an array of roles.
The last element of the array is null. If no users are found, an array of one element is returned with a value of null. The user calling this method must have ViewUserRight, UpdateTransferUserRight, or AdministratorRight. |
| retrieveAllUsersNotInRole | Retrieves all users that are not assigned to this role, and returns an array of users.
The last element of the array is null. If no users are found, an array of one element is returned with a value of null. The user calling this method must have ViewUserRight, UpdateTransferUserRight, or AdministratorRight. |
| addUserToRole | Assigns a role to a user.
The user calling this method must have UpdateTransferUserRight or AdministratorRight. |
| removeUserFromRole | Removes a role assigned to a user.
The user calling this method must have UpdateTransferUserRight or AdministratorRight. |