Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Active Directory User Management - Get

  • Article
  • 3 minutes to read

Operation Information

Retrieves the details about an Active Directory User account. By default the user is looked up directly by their identity (distinguished name, objectGUID, objectSid or sAMAccountName) supplied in UserIdentity. Alternatively, set SearchProperty to an Active Directory user property name (for example mail) to search the directory for a user whose value for that property matches the value supplied in UserIdentity.

Input Parameters

Name Type Description Required Sensitive
UserIdentity string When SearchProperty is empty, this is the Identity of the User to retrieve (distinguished name, objectGUID, objectSid or sAMAccountName). When SearchProperty is set, this is instead the value to match against that property (for example, the email address when SearchProperty is mail). Yes No
Server string The Active Directory Domain Services instance to perform the operation against No No
SearchProperty string Optional. The name of an Active Directory user property to search against (for example mail, employeeID or userPrincipalName). When supplied, the directory is searched for a user whose value for this property equals the value given in UserIdentity, instead of looking the user up directly by identity. Leave empty to look up by identity. No No

Output Parameters

Name Type Description Required Sensitive
errors string Any errors returned by the operation No No
outcome string Outcome of the operation. Can be OK or FAIL Yes No
AccountExpirationDate string Account Expiration Date No No
BadLogonCount string Bad Logon Count No No
badPwdCount string Bad Pwd Count No No
CannotChangePassword string Cannot Change Password No No
CanonicalName string Canonical Name No No
City string City No No
CN string CN No No
Company string Company No No
Country string Country No No
countryCode string Country Code No No
Department string Department No No
Description string Description No No
DisplayName string Display Name No No
DistinguishedName string Distinguished Name No No
Division string Division No No
EmailAddress string Email Address No No
EmployeeID string Employee I D No No
EmployeeNumber string Employee Number No No
Enabled string Enabled No No
GivenName string Given Name No No
HomeDirectory string Home Directory No No
HomeDrive string Home Drive No No
HomePage string Home Page No No
HomePhone string Home Phone No No
Initials string Initials No No
isDeleted string Is Deleted No No
LastLogonDate string Last Logon Date No No
LockedOut string Locked Out No No
Manager string Manager No No
MemberOf string Member Of No No
MobilePhone string Mobile Phone No No
Modified string Modified No No
modifyTimeStamp string Modify Time Stamp No No
Name string Name No No
ObjectGUID string Object G U I D No No
objectSid string Object Sid No No
Office string Office No No
OfficePhone string Office Phone No No
Organization string Organization No No
OtherName string Other Name No No
PasswordExpired string Password Expired No No
PasswordLastSet string Password Last Set No No
PasswordNeverExpires string Password Never Expires No No
PasswordNotRequired string Password Not Required No No
POBox string P O Box No No
PostalCode string Postal Code No No
PrimaryGroup string Primary Group No No
ProfilePath string Profile Path No No
ProtectedFromAccidentalDeletion string Protected From Accidental Deletion No No
SamAccountName string Sam Account Name No No
sn string Sn No No
State string State No No
StreetAddress string Street Address No No
Title string Title No No
uid string Uid No No
userAccountControl string User Account Control No No
UserPrincipalName string User Principal Name No No
whenChanged string When Changed No No
whenCreated string When Created No No
ProxyAddresses string Proxy Addresses No No
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document