UserRead
Displays the details for a user.
Example
http://12.3.4.56:9000/action=UserRead&UserName=Susan Smith
This action requests the details for the user Susan Smith
.
Required Parameters
The following action parameters are required.
Parameter | Description |
---|---|
Password | The user security repository password. |
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 | Whether to use another system for user authentication. |
Domain | The NT domain of the user. |
EmailAddress | The e-mail address of the user. |
FieldFieldName | A field for the user. |
Function | The function to perform. |
Group | The LDAP user directory. |
GroupDN | The group object that the user must belong to. |
GroupMemberAttribute | The attribute that determines that a user is a group member. |
InputEncoding | The encoding of the Domain and UserName. |
LoginFieldValue | The value for the user that must occur in the configured LoginFieldName. |
OutputEncoding | The encoding to convert the response to. |
Privilege | The user privileges for which to display the values for the user. |
Recurse | Whether to list the privilege values of the parent roles for the roles that the user belongs to. |
Repository | The security repository. |
RoleList | Whether to list the roles for the user. |
Security | A security field for the user. |
SecurityFields | Whether to display the user security fields. |
SecurityInfo | Whether to display the user security string. |
UserFieldMatch | The fields to display in the user details. |
This action accepts the following standard ACI action parameters.
Parameter | Description |
---|---|
ActionID | A string to use to identify an ACI action. |
EncryptResponse | Encrypt the output. |
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: