Get Enterprise User

URL:: https://<root>/security/users/getEnterpriseUser
Methods:: GET
Required Capability:: Access allowed with either the "Security and Infrastructure" or "Add" privileges
Version Introduced:: 10.3.1

Description

The getEnterpriseUser 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.

Request parameters

Parameter Details

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: Example Use dark colors for code blocksCopy `1 username=jdoe`
`f`	The response format. The default value is `html`. Values: `html` \| `json` \| `pjson`

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:

Example
Use dark colors for code blocksCopy
username=jdoe

f

The response format. The default value is html.

Values: html | json | pjson

Example usage

The following is a sample POST request URL for the getEnterpriseUser operation:

Use dark colors for code blocksCopy
POST /<context>/portaladmin/security/users/getEnterpriseUser HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

username=jdoe&f=json

JSON Response example

Use dark colors for code blocksCopy
{
  "username": "john",
  "fullname": "John Doe",
  "description": "cn=John Doe,ou=users,ou=ags,dc=domain",
  "email": "john_doe@email.com"
}