- URL: https://<users-url>/getEnterpriseUser
- Required Capability:Default administrator role | Security and infrastructure privilege | Add privilege
- Version Introduced:10.3.1
Description
This operation returns the description, full name, and email address for a single user in the enterprise identity (user) store configured with the portal. The username parameter is used to specify the enterprise user name. If the user does not exist, an error is returned.
Note:
This operation only works when an enterprise identity store such as Windows domain or LDAP has been configured using the Update Identity Store operation. This operation does not search SAML identity providers.
Request parameters
| Parameter | Details |
|---|---|
| username | User name of the enterprise account. For Windows Active Directory users, this can be either domain\username or username. For LDAP users, the format is always username. Example: |
| f | The response format. The default value is html. Values: html | json | pjson |
Example usage
The following is a sample request URL for getEnterpriseUser:
POST /webadaptor/portaladmin/security/users/getEnterpriseUser HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
username=jdoe&f=jsonJSON Response example
{
"username": "john",
"fullname": "John Doe",
"description": "cn=John Doe,ou=users,ou=ags,dc=domain",
"email": "[email protected]"
}