GetUsers
Lists users contained in each repository, or all repositories in GroupServerDefaultRepositories if none are specified.
You can filter the user list:
- Use the
Repositoryparameter to restrict the query to specific repositories. - Use the
Matchingparameter to match specific user names. You can use question mark (?) and asterisk (*) wildcards in your search string. - Use the
FieldNameandFieldValueparameters to return only those users that have the field specified byFieldNamewith the value specified byFieldValue. - Use the
GroupNameparameter to return only those users who are a member of the specified group.
/action=GetUsers[&Repository= ]
[&Matching= ]
[&FieldName=
&FieldValue= ]
[&AltUsernames=true/false]
[[&GroupName= ]
[&NestedGroups=true/false]]
Parameters
| Parameter | Description | Required |
|---|---|---|
| AltUsernames | A Boolean that specifies whether to get alternative user names. | No |
| EncryptResponse | Encrypt the output. | No |
| FieldName | Return only those users where the field specified by this parameter has the value specified by FieldValue. | No |
| FieldValue | Return only those users where the field specified by FieldName has the value specified by this parameter. | No |
| FileName | The file to write output to. | No |
| ForceTemplateRefresh | Forces the server to load the template from disk. | No |
| GroupName | Return only those users who are a member of the specified group. | No |
| Matching | Return only those users whose name matches the specified value. | No |
| NestedGroups | Specifies whether to include users who are a member of nested groups, when you include the GroupName parameter in the query. |
No |
| Output | Write output to a file. | No |
| Redirected | Allows the query to be performed against the repository. | No |
| Repository | Return only users contained in the specified repository. | No |
| Template | The template to use for the action output. | No |
| TemplateParamCSVs | A list of variables to use for the specified template. | No |
Example
/action=GetAllUsers&Matching=Sm?th*
This action instructs the group server to return all users whose name matches Sm?th*/ (for example, Smith, Smythe, Smithers and so on).
Response
The following is an example XML response to action=getusers&repository=NT,eRoom
<responsedata> <Users>JohnSmith</Users> <Users>JaneBrown</Users> ... <UserCount>28</UserCount> <Error>Repository 'eRoom' not recognized</Error> </responsedata>
If you set GroupServerShowAlternativeNames=TRUE, the response might be:
<responsedata> <Users>JohnSmith</Users> <Users>JaneBrown</Users> <Users alias_for="JohnSmith">JSmith</Users> <Users alias_for="JohnSmith">JohnS</Users> <Users alias_for="JohnSmith">JS</Users> <Users alias_for="JaneBrown">>JBrown</Users> <Users alias_for="JaneBrown">JaneB</Users> <Users alias_for="JaneBrown">JB</Users> --> ... <UserCount>28</UserCount> <Error>Repository 'eRoom' not recognized</Error> </responsedata>