OmniGroupServer 24.2

# GetUsers

Lists users contained in each repository, or all repositories in GroupServerDefaultRepositories if none are specified.

You can filter the user list:

- Use the `Repository` parameter to restrict the query to specific repositories.
- Use the `Matching` parameter to match specific user names. You can use question mark (`?`) and asterisk (`*`) wildcards in your search string.
- Use the `FieldName` and `FieldValue` parameters to return only those users that have the field specified by `FieldName` with the value specified by `FieldValue`.
- Use the `GroupName` parameter 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

This action accepts the following optional parameters.

Parameter | Description
--- | ---
AltUsernames | A Boolean that specifies whether to get alternative user names.
FieldName | Return only those users where the field specified by this parameter has the value specified by FieldValue.
FieldValue | Return only those users where the field specified by FieldName has the value specified by this parameter.
GroupName | Return only those users who are a member of the specified group.
Matching | Return only those users whose name matches the specified value.
NestedGroups | Specifies whether to include users who are a member of nested groups, when you include the `GroupName` parameter in the query.
Redirected | Allows the query to be performed against the repository.
Repository | Return only users contained in the specified repository.

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
FileName | The file to write output to.
ForceTemplateRefresh | Forces the server to load the template from disk.
Output | Writes output to a file.
ResponseFormat | The format of the action output.
Template | The template to use for the action output.
TemplateParamCSVs | A list of variables to use for the specified template.

## 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>

Copyright 2024 Open Text
Version 24.2 | Last updated March 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL OmniGroupServer 24.2

Topic Title: GetUsers