OmniGroupServer 12.13

# GetUser

Lists all the groups, alternative usernames, and user fields for the user specified by the `UserName` parameter.

The action lists the information for the repositories specified by the `Repositories` parameter. If you do not set the `Repositories` parameter, the action lists the information for all repositories specified by GroupServerDefaultRepositories in the OmniGroupServer configuration file. The results for each repository are concatenated.

    /action=GetUser[&Repository= ]
                    &Username=
                   [&AltUsernames=true/false]

## Parameters

Parameter | Description | Required
--- | --- | ---
AltUsernames | A Boolean that specifies whether to get alternative user names. | No
EncryptResponse | Encrypt the output. | No
FileName | The file to write output to. | No
ForceTemplateRefresh | Forces the server to load the template from disk. | No
Output | Write output to a file. | No
Redirected | Allows the query to be performed against the repository. | No
Repository | The repositories from which you want to get user information. | No
Template | The template to use for the action output. | No
TemplateParamCSVs | A list of variables to use for the specified template. | No
UserName | The name of the user whose information is returned. | Yes

## Example

    /action=GetGroups&UserName=DOMAIN1%5cJSmith

This instructs the group server to return information for the user `DOMAIN1\JSmith`.

## Response

Below is an example of an XML response to the action:

    action=GetGroups&UserName=DOMAIN1%5cJSmith&Repository=NT,eRoom

    <responsedata>
       <Groups>DOMAIN1\GROUPA</Groups>
       <Groups>DOMAIN1\GROUPB</Groups>
       <Groups>DOMAIN1\GROUPC</Groups>

       <Groups>DOMAIN2\GROUPA</Groups>
       <Groups>DOMAIN2\GROUPB</Groups>
       <Groups>DOMAIN2\GROUPC</Groups>
       <GroupCount>6</GroupCount>

       <UserName>DOMAIN1\JSMITH</UserName>
       <UserName alias_for="DOMAIN1\JSMITH">JohnS</UserName>
       <UserName alias_for="DOMAIN1\JSMITH">JS</UserName>

       <DisplayName>John Smith</DisplayName>
       <GivenName>John</GivenName>
       <Surname>Smith</Surname>
       <mail>john.smith@domain1.com</mail>

       <Error>Repository 'eRoom' not recognized</Error>
    </responsedata>

If you set both `GroupServerShowAlternativeNames=TRUE` and `GroupServerNumberAlternativeNames=TRUE`, the response instead contains:

    <UserName>DOMAIN1\JSMITH</UserName>
    <UserName0>DOMAIN1\JSMITH</UserName0>
    <UserName1>JohnS</UserName1>
    <UserName2>JS</UserName2>

TIP: It is expected that the primary username appears twice. The `alias_for` attribute is not included.

Setting `GroupServerNumberAlternativeNames=TRUE` is not recommended.

© Copyright 2022 Micro Focus or one of its affiliates
Version 12.13 | Last updated October 2022

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 swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL OmniGroupServer 12.13

Topic Title: GetUser