Versions Compared

Old Version 1

changes.mady.by.user Phillip Hanegan

Saved on

compared with

New Version Current

changes.mady.by.user Phillip Hanegan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Post /GetAllSearchAdvanced

Send a POST request to the GetAllSearchAdvanced() method on the AccountView object to return information about one or more accounts. The information included in the response depends on the range of account properties and parameter values included in the request.

A valid OAuth 2.0 Bearer token is required.

URL

Code Block
POST https://<FQDN_Of_Your_EmpowerID_Web_Server>/api/webui/v1/AccountView/GetAllSearchAdvanced

Header Key/Value Pairs

Key

Value

Authorization

Bearer <access_token>

X-EmpowerID-API-Key

The API key from the registered OAuth application

Content-Type

application/json

Request Body

The body of the request must include all parameters required by the method and the IncludedProperties object with at least one account property.

Included Properties

Use IncludedProperties to return one or more account properties. Example properties include PersonID AccountID, LastName, FirstName, and login. See Person Properties below for a fuller list of properties that can be returned NetBiosName.

Body Parameters

The GetAllSearchAdvanced() method includes a number of parameters that must be included in the body or the request. Use parameters to filter the number of accounts returned by the endpoint.

Expand
titleView Parameters

ShowSystemAccountsOnly

HideInEmpowerID

Boolean

AccountTypeID

AccountStoreID

int

  • Return all accounts with the same Account Typea matching account store ID

  • Set to null to ignore

  • Required

SecurityBoundaryID

int

  • Set to the ID of the Security Boundary to return accounts with a matching Security Boundary ID

  • Set to null to ignore

  • Required

AccountUsageTypeID

SecurityBoundaryTypeID

int

  • Return all accounts with the same Account Usage TypeSet to the ID of the Security Boundary Type to return accounts with a matching Security Boundary Type ID

  • Set to null to ignore

  • Required

Expand
titleView Account Usage Security Boundary Type IDs

Insert excerpt
IL:Account Usage Security Boundary Types
IL:Account Usage Security Boundary Types
nopaneltrue

Disabled

AccountTypeID

Booleanint

  • Return disabled all accounts with the same Account Type

  • Set to null to ignore

  • Required

IsOrphan

ShowSystemAccountsOnly

Boolean

  • Return accounts without an EmpowerID Personsystem accounts only

  • Set to null to ignore

  • Required

LockedOut

ShowSystemBuiltinAccountsOnly

Boolean

  • Return locked out system builtin accounts only

  • Set to null to ignore

  • Required

NeverLoggedInOnly

AccountUsageTypeID

Boolean

Set to the ID of the external approval to filter the call to only return people with a matching

int

  • Return all accounts with the same Account Usage Type

  • Set to null to ignore

  • Required

OrgZoneID

int

  • Set to the ID of the OrgZone (EmpowerID Location) to return accounts with a matching OrgZone

Expand
titleView Account Usage Type IDs

Insert excerpt
IL:Account Usage Types
IL:Account Usage Types
nopaneltrue

IsOrphan

Boolean

  • Return accounts without an EmpowerID Person

  • Set to null to ignore

  • Required

Disabled

Boolean

  • Return disabled accounts

  • Set to null to ignore

  • Required

SecurityBoundaryID

LockedOut

int

Set to the ID of the Security Boundary to return accounts with a matching Security Boundary ID

Boolean

  • Return locked out accounts

  • Set to null to ignore

  • Required

SecurityBoundaryTypeID

NeverLoggedInOnly

int

Set to the ID of the Security Boundary Type to return accounts with a matching Security Boundary Type ID

Boolean

  • Return accounts that have never logged in to the system

  • Set to null to ignore

  • Required

Expand
titleView Security Boundary Type IDs
Insert excerpt
IL:Security Boundary TypesIL:Security Boundary Types
nopaneltrue

  • Return system accounts onlythat are hidden in EmpowerID

  • Set to null to ignoreRequired

OrgZoneID

ShowSystemBuiltinAccountsOnly

Booleanint

  • Return system builtin accounts onlyaccounts with a matching OrgZone ID

  • Set to null to ignore

  • Required

accountStoreID

PersonID

int

  • Set to the ID of the account store to return all accounts with a matching account store ID Return accounts owned by the person with the specified ID

  • Set to null to ignore

  • Required

ManagerPersonID

int

  • Return accounts whose manager matches the specified ID

  • Set to null to ignore

  • Required

MemberOfGroupID

int

  • Return accounts with membership in the specified group

  • Set to null to ignore

  • Required

columnsToSearch

string

  • Specifies one or more search conditions. Formatted as follows:
    "%[[][[]%<Conditions><Condition PropertyName="\Name of the property to search\" SearchValue="\Value of the property\" Operator=\"Equality\" QuerySuffix=\" Suffix Value \"StartGroupString=\"\" EndGroupString=\"\" /></Conditions>"

  • Required

pageLength

int

  • Specifies the number of accounts to return in the list of accounts

  • Set to null to ignore

  • Required

resourceTags

String

  • Return accounts with a matching resource tag

  • Required

start

int

  • Specifies the first account in the list of accounts returned by the API; set to 0 to return the first account

  • Required

textToSearch

string

  • Set to AdvancedSearch

  • Required

totalCount

int

  • This is an output parameters parameter that returns the number of accounts matching the search conditions and parameter values.

  • Required

columnsToSearch

The columnsToSearch body parameter is used to return accounts meeting one or more conditions. Each condition specifies a property with a specific value to search and there can be more than one condition. For example, to return a list of accounts with belonging to the “DevDomain1” domain that are currently locked out, the value for columnsToSearch would be set to that shown below.

"%[[][[]%<Conditions><Condition PropertyName=\"NetBiosName\" SearchValue=\"Docs-tracking\" Operator=\"EqualTo\" QuerySuffix=\" AND \" StartGroupString=\"\" EndGroupString=\"\" Index=\"0\" SearchType=\"String\"/><Condition PropertyName=\"LockedOut\" SearchValue=\"true\" Operator=\"EqualTo\" QuerySuffix=\"\" StartGroupString=\"\" EndGroupString=\"\" Index=\"1\" SearchType=\"Boolean\"/></Conditions>"

Remarks

In the above example, columnsToSearch contains two search conditions. The API returns accounts matching both conditions. Each condition includes the PropertyName to search, the SearchValue to search for, an Equality Operator, a QuerySuffix and a SearchType for the relevant data type.

Search Examples

The below examples demonstrate how to use IncludedProperties, parameters, and conditions in columnsToSearch to query the API for a list of accounts matching the search conditions. Attributes returned for each record are set by the properties specified in IncludedProperties.

1️⃣ Set the ShowSystemAccountsOnly parameter to 1 to return a list of system accounts.

Code Block
languagejson
{
    "IncludedProperties": [        
        "LogonName",
        "NetBiosName",
        "FriendlyName",      
        "AccountOrganizationStatusFriendlyName",
        "AccountUsageTypeFriendlyName",       
        "ResourceID",
        "AccountID",
        "Name",
        "Description",
        "CreatedDate",
        "ExpiresOn",       
        "AccountStoreFriendlyName",       
    ],
    "Parameters": {
        "AccountTypeID": null,
        "AccountUsageTypeID": null,
        "Disabled": null,
        "HideInEmpowerID": null,
        "IsOrphan": null,
        "LockedOut": null,
        "NeverLoggedInOnly": null,        
        "OrgZoneID": null,
        "SecurityBoundaryID": null,
        "SecurityBoundaryTypeID": null,
        "ShowSystemAccountsOnly": 1,
        "ShowSystemBuiltInAccountsOnly": null,
        "accountStoreID": null,        
        "textToSearch": null,
        "columnsToSearch": "%[[][[]%<Conditions/>",
        "pageLength": 5,
        "resourceTags": null,
        "start": 0,
        "totalCount": null
    }
}

2️⃣ Get all personal privileged accounts that have never logged in to the system

Set the AccountUsageTypeID parameter to 2 and the NeverLoggedInOnly parameter to 1 to return Personal Privileged accounts that have never logged in to the system.

Code Block
{
    "IncludedProperties": [        
        "LogonName",
        "NetBiosName",
        "FriendlyName",
        "PersonID",
        "EmpowerIDLogon",
        "AccountOrganizationStatusFriendlyName",
        "AccountUsageTypeFriendlyName",
        "DistinguishedName",
        "LastLogonTime",
        "ValidUntil",
        "ResourceID",
        "AccountID",
        "Name",
        "Description",
        "CreatedDate",
        "ExpiresOn",
        "MustChangePasswordAtNextLogin",
        "LockedOut",
        "CannotChangePassword",
        "PasswordExpires",
        "PasswordLastChanged",
        "PasswordNeverExpires",
        "FirstName",
        "LastName",
        "Officelocation",
        "Location",
        "AccountStoreFriendlyName",
        "Email",
        "StreetAddress",
        "City",
        "State",
        "ZipCode",
        "Country",
        "Company",
        "JobTitle",
        "Department",
        "Telephone",
        "MobileNumber",
        "AccountManagerFriendlyName",
        "PersonOwnerLastAttestationDate",
        "PersonOwnerLastResourceAttestationSnapshotID"
    ],
    "Parameters": {
 
      "AccountTypeIDAccountStoreID": null,
        "AccountUsageTypeIDSecurityBoundaryID": 2null,
        "DisabledSecurityBoundaryTypeID": null,         
        "HideInEmpowerIDAccountTypeID": null,
        "IsOrphanShowSystemAccountsOnly": null,
        "LockedOutShowSystemBuiltInAccountsOnly": null,
        "NeverLoggedInOnlyAccountUsageTypeID": 12,
        "IsOrphan": null,
        "OrgZoneIDDisabled": null,        
        "SecurityBoundaryIDLockedOut": null,
        "SecurityBoundaryTypeIDNeverLoggedInOnly": null1, 
        "ShowSystemAccountsOnlyHideInEmpowerID": null,
        "ShowSystemBuiltInAccountsOnlyOrgZoneID": null,
        "accountStoreIDPersonID": null,
        "ManagerPersonID": null,
        "textToSearchMemberOfGroupID": null,
        "columnsToSearch": "%[[][[]%<Conditions/>",
        "textToSearch":"AdvancedSearch",
        "pageLength": 5,
        "resourceTags": null,
        "start": 0,
        "totalCount": null,
    }
}

3️⃣

Use columnsToSearch to return

Get all locked out accounts

.

Note the PropertyName for the search condition is set to LockedOut, SearchValue is set to True, the Operator is set to EqualTo and the SearchType is Boolean.

Code Block
{
    "IncludedProperties": [        
        "LogonNameAccountID",
        "NetBiosNameFriendlyName",
        "FriendlyNameFirstName",
              "AccountOrganizationStatusFriendlyName"LastName",
        "LogonName",
        "AccountUsageTypeFriendlyNameEmpowerIDLogon",      
         "ResourceIDNetBiosName",       
 "AccountID",         "NameAccountStoreFriendlyName",       
 "Description",   ],
     "CreatedDate"    "Parameters": {
        "AccountStoreID": null,
        "ExpiresOnSecurityBoundaryID",       : null,
        "AccountStoreFriendlyNameSecurityBoundaryTypeID": null,            
       ],
    "Parameters": {         "AccountTypeID": null,
        "AccountUsageTypeIDShowSystemAccountsOnly": 2null,
        "DisabledShowSystemBuiltInAccountsOnly": null,
        "HideInEmpowerIDAccountUsageTypeID": null,
        "IsOrphan": null,
        "LockedOutDisabled": null,        
"NeverLoggedInOnly": 1,       "LockedOut": null,
        "OrgZoneIDNeverLoggedInOnly": null, 
        "SecurityBoundaryIDHideInEmpowerID": null,
        "SecurityBoundaryTypeIDOrgZoneID": null,
        "ShowSystemAccountsOnlyPersonID": null,
        "ShowSystemBuiltInAccountsOnlyManagerPersonID": null,
        "accountStoreIDMemberOfGroupID": null,
                "textToSearch": null"AdvancedSearch",
        "pageLength": 5,
        "resourceTags": null,
        "start": 0,
        "totalCount": null,
        "columnsToSearch": "%[[][[]%<Conditions><Condition PropertyName=\"LockedOut\" SearchValue=\"true\" Operator=\"EqualTo\" 
                            QuerySuffix=\"\" StartGroupString=\"\" EndGroupString=\"\" Index=\"0\" SearchType=\"Boolean\"/></Conditions>"
    }
}

SearchTerms

Each identity object in the EmpowerID Identity Warehouse has a SearchTerms property with a specific set of search values that can used to return all objects matching those values. For accounts, SearchTerms encompass the Name, FriendlyName, Email, FirstName, LastName, LogonName, and UserPrincipalName properties. When used, the API returns all accounts where the specified search value finds a match in any of those properties. For example, if the search value is set to “Rogers”, the API would return all the following accounts

  • Any account with a match in the name

  • Any account with a match in the friendly name

  • Any account with a match in the first name

  • Any account with a match in the last name

  • Any account with a match in the logon name

  • Any account with a match in the email address

  • Any account with a match in the User Principal Name

The following examples illustrate how to use SearchTerms to return a subset of accounts:

1️⃣ Use SearchTerms to return the Account ID, friendly name, first name, last name, Logon name, EmpowerID Logon, NetBiosName, email address and account manager friendly name for all accounts where the search value is set to "rogers"

Code Block{         "IncludedProperties": [         "AccountID",

4️⃣ Get all accounts that are members of a specific group

Set the MemberOfGroupID parameter to the GUID of the target group

Code Block
{
    "IncludedProperties": [        
        "LogonName",
        "NetBiosName",
        "FriendlyName",      
        "AccountOrganizationStatusFriendlyName",
        "AccountUsageTypeFriendlyName",       
        "ResourceID",
        "AccountID",
        "Name",
        "Description",
        "CreatedDate",
        "ExpiresOn",       
        "AccountStoreFriendlyName",       
    ],
    "Parameters": {
       "AccountStoreID": null,
        "SecurityBoundaryID": null,
        "SecurityBoundaryTypeID": null,         
        "AccountTypeID": null,
        "ShowSystemAccountsOnly": null,
        "ShowSystemBuiltInAccountsOnly": null,
        "AccountUsageTypeID": null,
        "IsOrphan": null,
        "Disabled": null,        
        "LockedOut": null,
        "NeverLoggedInOnly": null, 
        "HideInEmpowerID": null,
        "OrgZoneID": null,
        "PersonID": null,
        "ManagerPersonID": null,
        "MemberOfGroupID": "4E375004-5E6F-415D-B049-4A112C100D12",      
        "textToSearch": null,
        "pageLength": 5,
        "resourceTags": null,
        "start": 0,
        "totalCount": null
        "columnsToSearch": "%[[][[]%<Conditions/>"
    }
}

SearchTerms

Each identity object in the EmpowerID Identity Warehouse has a SearchTerms property with a specific set of search values that can used to return all objects matching those values. For accounts, SearchTerms encompass the Name, FriendlyName, Email, FirstName, LastName, LogonName, and UserPrincipalName properties. When used, the API returns all accounts where the specified search value finds a match in any of those properties. For example, if the search value is set to “Rogers”, the API would return all the following accounts

  • Any account with a match in the name

  • Any account with a match in the friendly name

  • Any account with a match in the first name

  • Any account with a match in the last name

  • Any account with a match in the logon name

  • Any account with a match in the email address

  • Any account with a match in the User Principal Name

The following examples illustrate how to use SearchTerms to return a subset of accounts:

1️⃣ Get all accounts where the search value for SearchTerms is set to “Rogers”

Use SearchTerms to return the Account ID, friendly name, first name, last name, Logon name, EmpowerID Logon, NetBiosName, email address and account manager friendly name for all accounts where the search value is set to "rogers"

Code Block
{    
    "IncludedProperties": [
        "AccountID",
        "FriendlyName",
        "FirstName",
        "LastName",
        "LogonName",
        "EmpowerIDLogon",
        "NetBiosName",
        "Email",
       "AccountManagerFriendlyName"       
    ],
     "Parameters": {
        "AccountTypeID": null,
        "AccountUsageTypeID": null,
        "Disabled": null,
        "HideInEmpowerID": null,
        "IsOrphan": null,
        "LockedOut": null,
        "NeverLoggedInOnly": null,        
        "OrgZoneID": null,
        "SecurityBoundaryID": null,
        "SecurityBoundaryTypeID": null,
        "ShowSystemAccountsOnly": null,
        "ShowSystemBuiltInAccountsOnly": null,
        "accountStoreID": null,        
        "textToSearch":"AdvancedSearch",
        "pageLength": 5,
        "resourceTags": null,
        "start": 0,
        "totalCount": null,
        "columnsToSearch":"%[[][[]%<Conditions><Condition PropertyName=\"SearchTerms\" SearchValue=\"rogers\" Operator=\"EqualTo\" 
                          QuerySuffix=\"\" StartGroupString=\"\" EndGroupString=\"\" Index=\"0\" SearchType=\"String\"/></Conditions>"
    }
}

The response includes all accounts matching the search value. Note the properties where the match occurs.

Code Block
{
    "Tags": [],
    "Data": [
        {
            "AccountID": 7598177,
            "FriendlyName": "Steve Rogers",
            "FirstName": null,
            "LastName": null,
            "LogonName": "steve.rogers",
            "EmpowerIDLogon": null,
            "NetBiosName": "CALDAP-NEW2",
            "Email": null,
            "AccountManagerFriendlyName": null
        },
        {
            "AccountID": 474585,
            "FriendlyName": "RDice",
            "FirstName": "Robert",
            "LastName": "Dice",
            "LogonName": "0xbb25b643614a1b40b1d63f935aa08c62",
            "EmpowerIDLogon": null,
            "NetBiosName": "DEVDOMAIN1",
            "Email": "bdice@rogers.com",
            "AccountManagerFriendlyName": null
        },
        {
            "AccountID": 478601,
            "FriendlyName": "RDice",
            "FirstName": "Robert",
            "LastName": "Dice",
            "FriendlyNameLogonName": "0xe419fc6d9da1b24a98d112175396ac6b",
            "FirstNameEmpowerIDLogon": null,
            "LastNameNetBiosName",:         "LogonNameDEVDOMAIN1",
        "EmpowerIDLogon",    "Email": "bdice@rogers.com",
   "NetBiosName",         "EmailAccountManagerFriendlyName",: null
       "AccountManagerFriendlyName"       
    ] },
     "Parameters": {         "AccountTypeID": null,     {
   "AccountUsageTypeID": null,         "DisabledAccountID": null490102,
            "HideInEmpowerIDFriendlyName": null,"RDice",
            "IsOrphanFirstName": null,"Robert",
            "LockedOutLastName": null"Dice",
            "NeverLoggedInOnlyLogonName": null,    "0x658a5369fba3d249ace199425fd428e9",
            "OrgZoneIDEmpowerIDLogon": null,
            "SecurityBoundaryIDNetBiosName": null,"DEVDOMAIN1",
            "SecurityBoundaryTypeIDEmail": null,"bdice@rogers.com",
            "ShowSystemAccountsOnlyAccountManagerFriendlyName": null,
        "ShowSystemBuiltInAccountsOnly": null},
        "accountStoreID": null,{
            "AccountID": 484459,
   "textToSearch":"AdvancedSearch",         "pageLengthFriendlyName": 5, "Mindi Idell Rogers",
            "resourceTagsFirstName": null"atinder",
            "startLastName": 0"IdellRogers",
        "totalCount": null,         "columnsToSearch":"%[[][[]%<Conditions><Condition PropertyName=\"SearchTerms\" SearchValue=\"rogers\LogonName": Operator=\"EqualTo\""Mindi.IdellRogers",
            "EmpowerIDLogon": "Mindi.IdellRogers",
             QuerySuffix=\"\NetBiosName": StartGroupString=\"\" EndGroupString=\"\" Index=\"0\" SearchType=\"String\"/></Conditions>"
    }
}

The response includes all people matching the search value. Note the properties where the match occurs.

Code Block
{DEVDOMAIN1",
            "Email": "Mindi.IdellRogers@omd.com",
            "TagsAccountManagerFriendlyName": [ null
        }
    ],
    "DataOutParameters": [
        {
            "Name": "totalCount",
              "AccountID": 7598177,
   "Value": 1150
        }
    ]
}

2️⃣ Get all accounts that belong to the “CALDAP-NEW2” domain where the search value for SearchTerms is set to “Steve”

Code Block
{    
    "IncludedProperties": [
        "AccountID",
        "FriendlyName": "Steve Rogers",
   
        "FirstName": null,
   
        "LastName": null,
            "LogonName": "steve.rogers",
        "LogonName",
           "EmpowerIDLogon": null,

           "NetBiosName": "CALDAP-NEW2",
   
        "Email": null,
       "AccountManagerFriendlyName"       
    ],
       "AccountManagerFriendlyName"Parameters": {
        "AccountTypeID": null,
        }"AccountUsageTypeID": null,
        {
   "Disabled": null,
        "AccountIDHideInEmpowerID": 474585null,
   
        "FriendlyNameIsOrphan": "RDice"null,
 
          "FirstNameLockedOut": "Robert"null,
        "NeverLoggedInOnly": null,   "LastName": "Dice",    
        "LogonNameOrgZoneID": "0xbb25b643614a1b40b1d63f935aa08c62",
   null,
        "EmpowerIDLogonSecurityBoundaryID": null,

           "NetBiosNameSecurityBoundaryTypeID": "DEVDOMAIN1",
   null,
        "EmailShowSystemAccountsOnly": "bdice@rogers.com",
   null,
        "AccountManagerFriendlyNameShowSystemBuiltInAccountsOnly": null,
        },
    "accountStoreID": null,    {    
        "AccountIDtextToSearch": 478601"AdvancedSearch",

           "FriendlyNamepageLength": "RDice",
  5,
          "FirstNameresourceTags": "Robert",
   null,
        "LastNamestart": "Dice"0,
        "totalCount": null,
        "columnsToSearch":"%[[][[]%<Conditions><Condition PropertyName=\"SearchTerms\" SearchValue=\"LogonNamerogers\": Operator=\"0xe419fc6d9da1b24a98d112175396ac6bEqualTo\", 
            "EmpowerIDLogon": null,             "NetBiosName": "DEVDOMAIN1",
  QuerySuffix=\" AND \" StartGroupString=\"\" EndGroupString=\"\" Index=\"0\" SearchType=\"String\"/>
         "Email": "bdice@rogers.com",             "AccountManagerFriendlyName": null   <Condition PropertyName=\"NetBiosName\" SearchValue=\"CALDAP-NEW2\" Operator=\"EqualTo\" QuerySuffix=\"\" 
},         {             "AccountID": 490102,   StartGroupString=\"\" EndGroupString=\"\" Index=\"1\" SearchType=\"String\"/></Conditions>"
    }
     "FriendlyName": "RDice",
            "FirstName": "Robert",
            "LastName": "Dice",
            "LogonName": "0x658a5369fba3d249ace199425fd428e9",
            "EmpowerIDLogon": null,
            "NetBiosName": "DEVDOMAIN1",
            "Email": "bdice@rogers.com",
            "AccountManagerFriendlyName": null
        },
        {
            "AccountID": 484459,
            "FriendlyName": "Mindi Idell Rogers",
            "FirstName": "atinder",
            "LastName": "IdellRogers",
            "LogonName": "Mindi.IdellRogers",
            "EmpowerIDLogon": "Mindi.IdellRogers",
            "NetBiosName": "DEVDOMAIN1",
            "Email": "Mindi.IdellRogers@omd.com",
            "AccountManagerFriendlyName": null
        }
    ],
    "OutParameters": [
        {
            "Name": "totalCount",
            "Value": 1150
        }
    ]
}

2️⃣ Return all people belonging to the “CALDAP-NEW2” domain with a SearchTerm match equal to "Steve."

}

3️⃣ Get all accounts where the SearchValue of the SearchTerm is an email address containing "microsoft"

Easy html macro
theme{"label":"solarized_dark","value":"solarized_dark"}
contentByMode{"html":"<!doctype html>\r\n<link href=\"https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css\" rel=\"stylesheet\" integrity=\"sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC\" crossorigin=\"anonymous\">\r\n<link href=\"https://docs.empowerid.com/new_docs.css\" rel=\"stylesheet\">\r\n<link href=\"https://docs.empowerid.com/assets/css/EID-API-DOC.css\" rel=\"stylesheet\">\r\n<script src=\"https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js\" integrity=\"sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM\" crossorigin=\"anonymous\"></script>\r\n \r\n <div class = \"bd-callout bd-callout-info\">\r\n <p>When using <code>SearchTerms</code>, search results can be filtered to specific text within \r\n supported properties. </p> \r\n \r\n <p><code>\"%[[][[]%&lt;Conditions&gt;&lt;Condition PropertyName=\\\"SearchTerms\\\" SearchValue=\\\"Email_*microsoft\\\" \r\n Operator=\\\"EqualTo\\\" QuerySuffix=\\\" \\\" StartGroupString=\\\"\\\" EndGroupString=\\\"\\\" Index=\\\"0\\\" \r\n SearchType=\\\"String\\\"/&gt;&lt;/Conditions&gt;\"</code></p>\r\n \r\n<p class = \"bd-callout bd-callout-success\">For <code>SearchTerms</code>, the syntax for <code>SearchValue</code> is \r\n<code>Property_TextToSearch</code>. Include wildcards to broaden search results. For example, \r\nthe above search returns all accounts whose <code>Email</code> attribute contains <code>micorosft</code>. If not using \r\nwildcards, the API returns accounts where the value of the property begins with an exact match.</p>\r\n</div>\r\n","javascript":"","css":"code {\r\n padding: 2px 4px;\r\n font-size: 90%;\r\n color: #c7254e;\r\n background-color: #f9f2f4;\r\n border-radius: 4px;\r\n}"}
 Code Block
{    
    "IncludedProperties": [
        "AccountID",
        "FriendlyName",
        "FirstName",
        "LastName",
        "LogonName",
        "EmpowerIDLogon",
        "NetBiosName",
        "Email",
       "AccountManagerFriendlyName"       
    ],
     "Parameters": {
        "AccountTypeID": null,
        "AccountUsageTypeID": null,
        "Disabled": null,
        "HideInEmpowerIDAccountStoreID": null,
        "IsOrphanSecurityBoundaryID": null,
        "LockedOutSecurityBoundaryTypeID": null,         
        "NeverLoggedInOnlyAccountTypeID": null,
        "ShowSystemAccountsOnly": null,
        "OrgZoneIDShowSystemBuiltInAccountsOnly": null,
        "SecurityBoundaryIDAccountUsageTypeID": null,
        "SecurityBoundaryTypeIDIsOrphan": null,
        "ShowSystemAccountsOnlyDisabled": null,
        "ShowSystemBuiltInAccountsOnlyLockedOut": null,
        "accountStoreIDNeverLoggedInOnly": null,        
        "textToSearchHideInEmpowerID":"AdvancedSearch" null,
        "pageLengthOrgZoneID": 5null,
        "resourceTagsPersonID": null,
        "startManagerPersonID": 0null,
        "totalCountMemberOfGroupID": null,
        "columnsToSearch":"%[[][[]%<Conditions><Condition PropertyName=\"SearchTerms\" SearchValue=\"rogers\" Operator=\"EqualTo\"     "textToSearch":"AdvancedSearch",
                 "pageLength": 5,
    QuerySuffix=\" AND \" StartGroupString=\"\" EndGroupString=\"\resourceTags" Index=\"0\" SearchType=\"String\"/>: null,
        "start": 0,
        "totalCount": null,
               <Condition"columnsToSearch": "%[[][[]%<Conditions><Condition PropertyName=\"NetBiosNameSearchTerms\" SearchValue=\"CALDAP-NEW2Email_*microsoft\" Operator=\"EqualTo\" 
QuerySuffix=\"\" 
                          StartGroupString=\"\" EndGroupString=\"\" Index=\"0\" SearchType=\"String\"/></Conditions>"
    }
}  
Sample Responses 
 Tabs macro
defaultColor#42526e
activeColor#0052ccff
width30
hoverColor#0065FF
tabTypeno-icon
stylestyle-1
alignmentleft
[{"label":"200","id":"1","content":{"version":1,"type":"doc","content":[{"type":"codeBlock","attrs":{"language":"json"},"content":[{"type":"text","text":"  {\r\n    \"Tags\": [],\r\n    \"Data\": [\r\n        {\r\n            \"LogonName\": \"F6C48859-944D-4681-84ED-0102E04A5A7E\",\r\n            \"NetBiosName\": \"EIDApTenant\",\r\n            \"FriendlyName\": \"Microsoft Cloud App Security\",\r\n            \"AccountOrganizationStatusFriendlyName\": \"Active\",\r\n            \"AccountUsageTypeFriendlyName\": \"Personal Standard\",\r\n            \"ResourceID\": 1475848,\r\n            \"AccountID\": 1770969,\r\n            \"Name\": \"Microsoft Cloud App Security\",\r\n            \"Description\": \"Microsoft Cloud App Security\",\r\n            \"CreatedDate\": \"2021-08-02T11:31:56.043\",\r\n            \"ExpiresOn\": \"1900-01-01T00:00:00\",\r\n            \"AccountStoreFriendlyName\": \"EIDApTenant\"\r\n        },\r\n        {\r\n            \"LogonName\": \"FCAAD45A-B48C-4913-BF51-01081FBFCE1E\",\r\n            \"NetBiosName\": \"EIDApTenant\",\r\n            \"FriendlyName\": \"Microsoft Azure Alerts Management\",\r\n            \"AccountOrganizationStatusFriendlyName\": \"Active\",\r\n            \"AccountUsageTypeFriendlyName\": \"Personal Standard\",\r\n            \"ResourceID\": 1475849,\r\n            \"AccountID\": 1770970,\r\n            \"Name\": \"Microsoft Azure Alerts Management\",\r\n            \"Description\": \"Microsoft Azure Alerts Management\",\r\n            \"CreatedDate\": \"2021-08-02T11:31:56.043\",\r\n            \"ExpiresOn\": \"1900-01-01T00:00:00\",\r\n            \"AccountStoreFriendlyName\": \"EIDApTenant\"\r\n        },\r\n        {\r\n            \"LogonName\": \"19D1D2BF-40E3-4850-97A1-0147B94D382E\",\r\n            \"NetBiosName\": \"EIDApTenant\",\r\n            \"FriendlyName\": \"Azure AD Identity Governance\",\r\n            \"AccountOrganizationStatusFriendlyName\": \"Active\",\r\n            \"AccountUsageTypeFriendlyName\": \"Personal Standard\",\r\n            \"ResourceID\": 1475850,\r\n            \"AccountID\": 1770971,\r\n            \"Name\": \"Azure AD Identity Governance\",\r\n            \"Description\": \"Azure AD Identity Governance\",\r\n            \"CreatedDate\": \"2021-08-02T11:31:56.043\",\r\n            \"ExpiresOn\": \"1900-01-01T00:00:00\",\r\n            \"AccountStoreFriendlyName\": \"EIDApTenant\"\r\n        },\r\n        {\r\n            \"LogonName\": \"DF2D22DC-649F-439C-A8C3-029F489CAD69\",\r\n            \"NetBiosName\": \"EIDApTenant\",\r\n            \"FriendlyName\": \"OfficeClientService\",\r\n            \"AccountOrganizationStatusFriendlyName\": \"Active\",\r\n            \"AccountUsageTypeFriendlyName\": \"Personal Standard\",\r\n            \"ResourceID\": 1475851,\r\n            \"AccountID\": 1770972,\r\n            \"Name\": \"OfficeClientService\",\r\n            \"Description\": \"OfficeClientService\",\r\n            \"CreatedDate\": \"2021-08-02T11:31:56.043\",\r\n            \"ExpiresOn\": \"1900-01-01T00:00:00\",\r\n            \"AccountStoreFriendlyName\": \"EIDApTenant\"\r\n        },\r\n        {\r\n            \"LogonName\": \"E907C818-74BA-480A-9D96-0310CF06B3EF\",\r\n            \"NetBiosName\": \"EIDApTenant\",\r\n            \"FriendlyName\": \"Azure Marketplace Container Management API\",\r\n            \"AccountOrganizationStatusFriendlyName\": \"Active\",\r\n            \"AccountUsageTypeFriendlyName\": \"Personal Standard\",\r\n            \"ResourceID\": 1475852,\r\n            \"AccountID\": 1770973,\r\n            \"Name\": \"Azure Marketplace Container Management API\",\r\n            \"Description\": \"Azure Marketplace Container Management API\",\r\n            \"CreatedDate\": \"2021-08-02T11:31:56.043\",\r\n            \"ExpiresOn\": \"1900-01-01T00:00:00\",\r\n            \"AccountStoreFriendlyName\": \"EIDApTenant\"\r\n        }\r\n    ],\r\n    \"OutParameters\": [\r\n        {\r\n            \"Name\": \"totalCount\",\r\n            \"Value\": 2924\r\n        }\r\n    ]\r\n}"}]},{"type":"paragraph","content":[]}]},"icon":"bootstrap/FillCircleFill"},{"label":"401","id":"2","content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"This error occurs when there is an issue with the access token."}]},{"type":"paragraph","content":[]}]},"icon":"bootstrap/FillCircleFill"},{"label":"500","id":"6a16m5mmd","content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"This error indicates that the API call included an invalid parameter."}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"type":"text","text":"{\n    {\n    \"Message\": \"An error has occurred.\",\r\n    \"ExceptionMessage\": \"The given key was not present in the dictionary.\"\n}"}]},{"type":"paragraph","content":[]}]},"icon":"bootstrap/FillCircleFill"}]
 Page Properties
hiddentrue
Account Properties
The below table includes Account Properties that can be added to IncludedProperties.
Property
Returns
AccountID
int
The ID of the account
AccountStoreID
int
The ID of the account store associated with the account
AccountTypeID
int
The ID of the account type
 Expand
titleView Account Type IDs
 Insert excerpt
IL:Account Type IDs
IL:Account Type IDs
nopaneltrue
FriendlyName
string
The Friendly Name of the person
 
Name
string
The full name of the person
Login
string
The EmpowerID login for the person
Email
string
The email address of the person
null if empty
EmailAlias
string
The email alias of the person
null if empty
PersonalEmail
string
The personal email address of the person
null if empty
ResourceID
int
The ResourceID of the person
PrimaryOrgRoleOrgZoneID
int
The ID of the person’s primary Business Role and Location
PersonGUID
string
The unique identifier for the person
Active
Boolean
True or False
PersonalTitle
string
The personal title
null if empty
FirstName
string
The person’s first name
MiddleName
string
The person’s middle name
null if empty
LastName
string
The person’s last name
SecondLastName
string
The person’s second last name
null if empty
GenerationalSuffix
string
The person’s generational suffix
null if empty
BirthName
string
The person’s birth name
null if empty
Initials
string
The person’s initials
null if empty
Title
string
The person’s title
null if empty
AboutMe
string
The information in the AboutMe field of a person
null if empty
StreetAddress
string
The person’s street address
null if empty
StreetAddress2
string
The second line of street address
null if empty
City
string
The person’s city
null if empty
State
string
The person’s state
null if empty
PostalCode
string
The person’s postal code
null if empty
Country
string
The person’s country
null if empty
Province
string
The person’s province
null if empty
Company
string
The person’s company
null if empty
Division
string
The person’s division
null if empty
Department
string
The person’s department
null if empty
DepartmentNumber
string
The person’s department number
null if empty
Office
string
The person’s office
null if empty
POBox
string
The person’s Post Office Box
null if empty
Location
string
The person’s location
null if empty
SocialSecurityNumber
string
The person’s Social Security Number
null if empty
NationalIdentificationNumber
string
The person’s National Identification Number
null if empty
CarLicense
string
The person’s vehicle license plate number
null if empty
DriversLicenseNumber
string
The person’s driver’s license number
null if empty
Ethnicity
string
The person’s ethnicity
null if empty
Gender
string
The person’s gender
null if empty
District
string
The District for the person
null if empty
Assistant
string
The name of the assistant for the person
null if empty
PhotoURL
string
The Photo URL for the person
null if empty
IMAddress
string
The IM address for the person
null if empty
SIPAddress
string
The SIP address for the person
null if empty
IdentityURL
string
The Identity URL for a person
null if empty
URLPersonal
string
The Personal URL for a person
null if empty
URLBusiness
string
The Business URL for a person
null if empty
URLOWA
string
The OWA URL for a person
null if empty
Telephone
string
The telephone number for the person
null if empty
MobilePhone
string
The mobile phone number for the person
null if empty
BusinessPhone
string
The business phone number for the person
null if empty
Pager
string
The pager number for the person
null if empty
HomeTelephone
string
The home telephone number for the person
null if empty
FAX
string
The fax number of a person
null if empty
Notes
string
Notes about a person
null if empty
MustChangePasswordOnNextLogin
Boolean
Specifies whether the person must change their password on their next login
True or False
LastLoginDate
DateTime
Date the person last logged in
LastPasswordChangedDate
DateTime
Date the person’s password was changed
FirstLoginFailedAttempt
DateTime
Date of the first logn failure for the person
null if empty
FailedLoginAttemptsCount
int
Number of failed lgoin attempts for the person
0 if no failed attempts
DisableSSOLogin
Boolean
Specifies whether the person can login via SSO
True or False
LockedUntil
DateTime
Date the person is locked out of the system due to login failures
null if empty
Description
string
Description of the person
null if empty
ValidFrom
DateTime
Date the person account became valid
null if empty
ValidUntil
DateTime
Date the person account becomes invalid
null if empty
DateOfBirth
DateTime
Birth date of the person
null if empty
CityOfBirth
string
Birth city of the person
null if empty
CountryOfBirth
string
Birth country of the person
null if empty
NationID
int
Nation ID of the person
null if empty
IsOutOfOffice
Boolean
Specifies the Out Of Office status of the person
True or False
EmployeeID
string
Employee ID of the person
null if empty
EmployeeIDOther
string
Secondary Employee ID of tjhe person
null if empty
ManagerPersonID
int
PersonID of the person’s manager
null if empty
EmployeeType
string
The person’s Employee type
null if empty
EmployeeTypeOther
string
The person’s Secondary Employee type
null if empty
MobilePhoneProviderID
int
The ID of the person’s mobile phone provider
null if empty
Status
string
The person’s account status
Active or Disabled
LocaleID
int
LocaleID of the person’s Locale
null if empty
ProfileManagerLastUpdated
DateTime
The date the person’s profile was last updated
null if empty
OrgRoleOrgZoneFriendlyName
string
The Friendly Name of the person’s Business Role and Location
CoreIdentityID
int
The ID of the Core Identity linked to the person
PersonProofingStatusFriendlyName
string
The status of the person’s proofing status
PersonManagerName
string
The name of the person’s manager
TimeConstrain
XML
Time constraint data for the person
XML format
TimeConstraintActive
Boolean
Specifies whether an active time constraint exists for the person
True or False
AllowLogin
Boolean
Specifies whether the person can log in
True or False
AllowPasswordOperations
Boolean
Specifies whether the person can update their passwords
True or False
AllowAttributeSync
Boolean
Specifies whether attribute sync is allowed between the person account and any owned external user accounts
True or False
AllowOrgRoleOrgZoneReEval
Boolean
Specifies whether the Business Role and Location of the person can be re-evaluated
True or False
LogonNameBeforeDeleted
string
The logon name before the person account was deleted
null if the person has not been deleted
Deleted
Boolean
Specifies whether the person account has been deleted
True or False
DeletedDate
DateTime
The date the person account was deleted
null if the person has not been deleted
SessionDirtyDate
DateTime
The date of the person’s last session
null if empty
RiskFactorTotal
int
The total risk factor score associated with the person
null if empty
RiskFactorTotalCalculated
DateTime
The date the person’s total risk factor score was calculated
CreatedDate
DateTime
The date and time the person account was created in the system
ModifiedDate
DateTime
The date and time any person attributes were modified for the person
DisableNotifications
Boolean
Specifies whether system notifications are disabled for the person
True or False
DisableAsApprover
Boolean
Specifies whether approval notifications are disabled for the person
True or False
PreferredFirstName
string
The preferred first name of the person
null if empty
PreferredLastName
string
The preferred last name of the person
null if empty
ExpectedHireDate
DateTime
The expected hire date for the person
null if empty
OriginalHireDate
DateTime
The person’s original hire date
null if empty
TerminationDate
DateTime
The date the person was terminated from the company
null if empty
OrganizationID
string
 
The ID of the person’s organization
LoginRequireDeviceRegistration
Boolean
Specifies whether the person’s devices must be registered to log in to the Web app
True or False
RequireSecondFactor
Boolean
Specifies whether second factor authentication is required for the person to log in
True or False
RequireSecondFactorForLDAP
Boolean
Specifies whether second factor authentication is required for the person to log in via LDAP
True or False
RequireSecondFactorForRadius
Boolean
Specifies whether second factor authentication is required for the person to log in via RADIUS
True or False
LastChatStatus
string
The last chat status of the person
null if empty
JobCode
string
The peson's job code
null if empty
PositionCode
string
The person’s position code
null if empty
DefaultHomePage
string
The default home page of the Web application for the person
null if empty
RoomNumber
string
The person’s room number
null if empty
BusinessCategory
string
The business category for the person
null if empty
OrgUnit
string
The person’s org unit
null if empty
SearchTerms
string
Search terms used to return the person in the search fields of the Web application
DistinguishedName
strimng
Distinguished name of the person account
CoreIdentityID
string
ID of the person’s Core Identity object
null if empty
ProcessStatus
int
Process status for the person’s account
2 for provisioned
ProcessTime
DateTime
The date and time the system processed the person’s account
DisabledDate
DateTime
The date the person’s account was disabled
null if empty
OwnerAssigneeID
string
Unique identifier of the owner of the person’s account
null if empty
IsExternal
Boolean
Specifies whether the person is external to the organization
True or False
HRNumber
string
The person’s HR Number
null if empty
DepartmentType
string
The person’s Department Type
null if empty
DepartmentCode
string
The person’s Department Code
null if empty
CompanyType
string
The person’s company type
null if empty
CompanyCode
string
The company code for the person
null if empty
CostCenter
string
The cost center for the person
null if empty
BusinessUnit
string
The person’s business unit
null if empty
PositionID
string
The ID of the person’s position
null if empty
SiteCode
string
The Site Code for the person’s site
null if empty
SiteName
string
The Site Name for the person’s site
null if empty
WorkingCompany
string
The Working Company of the person
null if empty
PreferredLanguage
string
The person’s preferred language
null if empty
SuspensionStartDate
DateTime
The suspension start date for the person
null if empty
SuspensionEndDate
DateTime
The suspension end date for the person
null if empty
IsContingentWorker
Boolean (nullable)
Specifies whether the person is a contingent worker
null if not set
IsFullTimeEmployee
Boolean (nullable)
Specifies whether the person is a full-time employee
null if not set
WorkingDaysPerWeek
int
The number of days per week the person works
null if empty
StandardHours
int
The standard hours for the person
null if empty
WorkLocation
string
The person’s work location
null if empty
BusinessTitle
string
The person’s Business Title
null if empty
Region
string
The person’s region
null if empty
IsEmailAcountRequired
Boolean (nullble)
Specifies whether an email account is required for the person
null if not set
JobCodeDescription
string
The person’s Department Code
null if empty
JobLocationName
string
The person’s Department Code
null if empty
County
string
The person’s county
null if empty
StreetAddress3
string
 
The third line of the person’s Street Address
null if empty
PreferredState
string
The person’s preferred state
null if empty
ThirdName
string
The person’s third name
null if empty
CostCenterDescription
string
The cost center description for the person
null if empty
CompanyDescription
string
The person’s company description
null if empty
LeaveOfAbsenseActualReturnDate
DateTime
The date the person returned from a leave of absence
null if empty
LeaveOfAbsenseExpectedReturnDate
DateTime
The date the person is expected to return from a leave of absence
null if empty
LeaveOfAbsenseStartDate
DateTime
The date the person starts a leave of absense
null if empty
LeaveOfAbsenseEndDate
DateTime
The date the person’s leave of absence ends
null if empty
WorkOrderStartDate
DateTime
The work order start date for a person
null if empty
WorkOrderEndDate
DzateTime
The work order end date for a person
null if empty
WorkOrderId
String
The work order ID for a person
null if empty
EffectiveStartDate
DateTime
The effective start date for a person
null if empty
EffectiveEndDate
DateTime
The effective end date for a person
null if empty
IsPrimary
Boolean
Specifies whether the account is the primary person
True or False
ExcludeFromResourceEntitlement
Boolean
Specifies whether the person is excluded from recieving any resource entitlements granted by provisioning policies.
True or False
IsSaaS
Boolean
Specifies whether the person is a SaaS account
True or False
SendEmailAsEncrypted
Boolean
Specifies whether email is to be sent encrypted
True or False
PreferredDataLocation
string
The preferred data location for a p
null if empty
ChangeTS
DateTime
The date and time a change occured on the person
OofEndDate
DateTime
Date and time a person’s Out of Office status ends
null if empty
OofInternalMsg
string
Out of Office message sent to internal users
null if empty
OofExternalMsg
string
Out of Office message sent to external users
null if empty
OofAudience
string
Out of Office audience
null if empty
OofStatus
string
Out of Office status
null if empty
OofStartDate
DateTime
Date and time the person’s Out of Office status begins
null if empty
BotConversationReferenceID
string
Unique identifier of the person’s BOT conversation
null if empty
CitizenNationID
int
Nation ID for the person
null if empty
Currency
string
Currency used by the person
null if empty
DefaultCurrency
string
Default currency for the person
null if empty
 Div
stylefloat:left; position:fixed;
idarticleNav
IN THIS ARTICLE
 Table of Contents
maxLevel3
minLevel2
stylenone
printablefalse
 Insert excerpt
IL:External Stylesheet
IL:External Stylesheet
nopaneltrue