Community Component 25.3
Community Component Help

# UserReadAgentList

Lists the agents that belong to a user.

## Example

    http://12.3.4.56:9030/action=UserReadAgentList&UserName=Administrator

This action requests a list of agents for the `Administrator` user.

## Required Parameters

You must set one of the following parameters.

Parameter | Description
--- | ---
UID | The user ID of the user to authenticate.
UserName | The user name of the user to authenticate.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
DeferLogin | Use another system for user authentication.
EmailAddress | The e-mail address of the user.
FieldFieldName | A field for the user.
InputEncoding | The encoding of the UserName.
OutputEncoding | The encoding to convert the response to.
Security | A security field for the user.
UserDetails | Returns user details.
UserFieldMatch | The user fields to display.

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.

## Comments

You must set one of the following parameters:

- UID

- UserName

Copyright 2025 Open Text
Version 25.3 | Last updated July 2025

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: Knowledge Discovery Community Component 25.3

Topic Title: UserReadAgentList