Users.getUserAndGroupsList (Method)
Returns User and his/her groups.
Returns:
Users_GetUserAndGroupsList_Result (query)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
Description | PlainText | The description of the group, or empty string if user. |
Name | PlainText_NonNull | The group or user's name. |
UserGroupID | UserGroupID | The user or group's ID. |
UserGroupType | UserGroupType | String indicating the type of administrator, either 'User' or 'Group'. |
Arguments:
Name | Type | Required | Description |
---|---|---|---|
userID | UserID_NEG1 | Optional. Defaults to '-1'. | A valid userID or -1 for current user. |
excludeList | GroupIDList_EmptyString | Optional. Defaults to an empty string. | A comma-delimited list of one or more IDs of the groups that CommonSpot will exclude from a search. An empty string tells CommonSpot that is should not exclude groups. |
searchField | UserGroupSearchField | Optional. Defaults to 'GroupName'. | The field upon which to search. This can be 'FirstName', 'GroupDescription', 'GroupName', 'LastName', 'MiddleName' or 'UserName'. |
searchOperator | SearchOperator_EmptyString | Optional. Defaults to an empty string. | A search operator or an empty string. Examples are 'Begins With', 'Contains', 'Ends With', and 'Equals'. |
searchString | PlainText | Optional. Defaults to an empty string. | The value for which CommonSpot searches. |
orderBy | SQLOrderByClause | Optional. Defaults to 'groupName'. | The SQL 'order by' clause indicating which column is used as the returned data's sort key. |
Context:
License Requirements | None |
Permission Requirements | User:Current |
Deny Context | None |
Require Context | None |
Author Lock | (not required) |
Transaction Logging | Transaction logging is disabled for this method |
Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None