- URL:https://<root>/orgs/<orgID>/security/users/getEnterpriseUser(POST only)
- Required Capability:Default administrator role | Security and infrastructure
- Version Introduced:10.9
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 organization. If the user does not exist, an error is returned.
Note:
This operation only supports enterprise identity stores, such as Windows domain or LDAP, that have been configured using the update identity store operation. This operation does not search SAML identity providers.Request parameters
Parameter | Details |
---|---|
username | The username 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 format is html. Values: html | json | pjson |
Example usage
The following is a sample POST request for getEnterpriseUser:
POST /context/admin/orgs/0123456789ABCDEF/security/users/getEnterpriseUser
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
username=jdoe&f=pjson&token=Mb0ORrkLObNO2Q8FZoUCHHzSMzZi0CbhLHNRYMqqa6URG_ojQJF3rNsJAfRB23MyCrLwSmuaHPUo4AEIrUuoH1-4Ot5xh4565FtlQahXAhK2C7Sy0oydZhBwD8KdFSnVlnLr-e9uI5ovSWZ2lGNn9SwoV2MPMzeAh_5r-q-wgwF8DTT_nhuCXJGkMRy-48jjGS2aN5FI18STHZ8RAuKxGasH90SI3C7njZzlGCUrY5m6BDhCMsdpZA14GwNX8Cis
JSON Response example
{
"username": "john",
"fullname": "John Doe",
"description": "cn=John Doe,ou=users,ou=ags,dc=domain",
"email": "john_doe@email.com"
}