Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Post /
GetAllSearchThis endpoint returnsGetAllSearchAdvanced
Send a POST request to the GetAllSearchAdvanced()
method on the PersonView
object to return information about one or more people within the organization. The information included in the response depends on the range of Person properties and parameter values included in the request.
A valid OAuth 2.0 Bearer token is required.
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<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 <p class = \"bd-callout bd-callout-info\">The user information included in the \r\n response depends on the range of Person properties requested \r\n and the value set for the <code>SearchTerms</code> property in the \r\n <code>columnsToSearch</code> parameter.</p>","javascript":"","css":"code {color: #212529 !important; background:#F4F5F7}"} |
URL
Code Block |
---|
POST https://<FQDN_Of_Your_EmpowerID_Web_Server>/api/webui/v1/PersonView/GetAllSearch |
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 the IncludedProperties
object and body parameters to filter the data returned. Use IncludedProperties
to return specific attributes for each person. Use body parameters to search for specific text.
Included Properties
Use IncludedProperties
to return person properties returned by the endpoint.
Property
Returns
PersonID
int
The PersonID of the person
FriendlyName
string
The Friendly Name of the person
Name
string
The full name of the person
Login
string
The EmpowerID login for the person
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 accountTrue
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
Body Parameters
Body parameters include textToSearch
and columnsToSearch
. Of the two, columnsToSearch
is of special importance as it uses the SearchTerms
property to filter the specific people returned by the call. Each identity object in the EmpowerID Identity Warehouse has a set of SearchTerms
associated with it. For people, SearchTerms
include the following:
Name
FriendlyName
Email
FirstName
LastName
Login
Parameters
Value
Remarks
textToSearch
string
*
columnsToSearch
string
Uses SearchTerms
and SearchValue
as the search condition.
e.g. %[[][[]%<Conditions><Condition PropertyName=\"SearchTerms\" SearchValue=\"PYancey\" Operator=\"EqualTo\" QuerySuffix=\"\" StartGroupString=\"\" EndGroupString=\"\" Index=\"0\" SearchType=\"String\"/></Conditions>"
The API returns all people where there is a SearchTerm
match for the SearchValue
. For example, if the SearchValue
is set to "jordan", the API would return:
All people with a first name containing the string
All people with last name containing the string
All people with a login containing the string
All people with an email address containing the string
Sample Body Data
This example shows what to include in the body of a call to return the Person ID, status, last name, first name, login, email address, risk factor score, and last login date of all people where the SearchValue
for SearchTerms
is set to "jordan."
language | json |
---|
URL
Code Block |
---|
POST https://<FQDN_Of_Your_EmpowerID_Web_Server>/api/webui/v1/PersonView/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 Person property.
Included Properties
Use IncludedProperties
to return one or more Person properties. Example properties include PersonID
, LastName
, FirstName
, and login
. See Person Properties below for a fuller list of properties that can be returned.
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 people returned by the endpoint.
Active
|
|
Company
|
|
CompanyID
|
|
CoreIdentityID
|
|
Department
|
|
ExternalApprovalID
|
|
GroupID
|
|
IsExternal
|
|
ManagementRoleID
|
|
OrgRoleID
|
|
OrgRoleOrgZoneID
|
|
OrgZoneID
|
|
OwnerAssigneeID
|
|
PersonOrganizationStatusID
|
|
PersonUsageTypeID
|
|
PrimaryOrgRoleOrgZoneID
|
|
SetGroupID
|
|
columnsToSearch
|
|
textToSearch
|
|
columnsToSearch
The columnsToSearch
body parameter is used to return people 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 people with a manager named Jorge Posada who logged in between 9/20/2021 and 9/21/2021, the parameter would be set to the below value.
"columnsToSearch": "%[[][[]%<Conditions><Condition PropertyName=\"PersonManagerName\" SearchValue=\"jorge posada\" Operator=\"EqualTo\" QuerySuffix=\" AND \" SearchType=\"String\"/><Condition PropertyName=\"LastLoginDate\" SearchValue=\"2022-09-21\" Operator=\"GreaterThan\" QuerySuffix=\" AND \" StartGroupString=\"\" EndGroupString=\"\" SearchType=\"DateTime\"/><Condition PropertyName=\"LastLoginDate\" SearchValue=\"2022-09-22\" Operator=\"LessThan\" QuerySuffix=\"\" SearchType=\"DateTime\"/></Conditions>"
Remarks
In the above example, columnsToSearch
contains a concatenation of three search conditions. The API returns people matching all three 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
and conditions in columnsToSearch
to query the API for a list of people matching the search conditions. Attributes returned for each record are set by the properties specified in IncludedProperties
.
1️⃣ Return all people with a manager named “George Smythe” who have logged in between 2022-09-21
and 2022-09-22
. Note that SearchType
is set to String
for the first condition and DateTime
for the second and third conditions.
Code Block | ||
---|---|---|
| ||
{
"IncludedProperties": [
"PersonID",
"LastName",
"FirstName",
"Login",
"Email",
"PersonManagerName"
],
"Parameters": {
"ExternalApprovalID": null,
"GroupID": null,
"Active": null,
"CompanyID": null,
"CoreIdentityID": null,
"ManagementRoleID": null,
"OrgRoleID": null,
"OrgRoleOrgZoneID": null,
"OrgZoneID": null,
"OwnerAssigneeID": null,
"PersonOrganizationStatusID": null,
"PrimaryOrgRoleOrgZoneID": null,
"SetGroupID": null,
"IsExternal": null,
"PersonUsageTypeID": null,
"Department": null,
"Company": null,
"textToSearch": "*",
"columnsToSearch": "%[[][[]%<Conditions><Condition PropertyName=\"PersonManagerName\" SearchValue=\"George Smythe\" Operator=\"EqualTo\"
QuerySuffix=\" AND \" SearchType=\"String\"/><Condition PropertyName=\"LastLoginDate\" SearchValue=\"2022-09-21\"
Operator=\"GreaterThan\" QuerySuffix=\" AND \" StartGroupString=\"\" EndGroupString=\"\" SearchType=\"DateTime\"/>
<Condition PropertyName=\"LastLoginDate\" SearchValue=\"2022-09-22\" Operator=\"LessThan\" QuerySuffix=\"\"
SearchType=\"DateTime\"/></Conditions>"
}
} |
2️⃣ Return all people with an Active status that belong to the group specified by the GroupID
parameter.
Code Block |
---|
{
"IncludedProperties": [
"PersonID",
"Active",
"LastName",
"FirstName",
"Login",
"RiskFactorTotal",
"LastLoginDate"
],
"Parameters": {
"ExternalApprovalID": null,
"GroupID": 823237,
"Active": null,
"CompanyID": null,
"CoreIdentityID": null,
"ManagementRoleID": null,
"OrgRoleID": null,
"OrgRoleOrgZoneID": null,
"OrgZoneID": null,
"OwnerAssigneeID": null,
"PersonOrganizationStatusID": null,
"PrimaryOrgRoleOrgZoneID": null,
"SetGroupID": null,
"IsExternal": null,
"PersonUsageTypeID": null,
"Department": null,
"Company": null,
"textToSearch": "*",
"columnsToSearch": "%[[][[]%<Conditions><Condition PropertyName=\"Active\" SearchValue=\"true\" Operator=\"EqualTo\" QuerySuffix=\"\"
StartGroupString=\"\" EndGroupString=\"\" Index=\"0\" SearchType=\"Boolean\"/></Conditions>"
}
} |
3️⃣ Return all people belonging to the “Sales in Dublin” Business Role and Location.
Code Block |
---|
{
"IncludedProperties": [
"PersonID",
"Active",
"LastName",
"FirstName",
"Login",
"OrgRoleOrgZoneFriendlyName"
],
"Parameters": {
"ExternalApprovalID": null,
"GroupID": null,
"Active": null,
"CompanyID": null,
"CoreIdentityID": null,
"ManagementRoleID": null,
"OrgRoleID": null,
"OrgRoleOrgZoneID": null,
"OrgZoneID": null,
"OwnerAssigneeID": null,
"PersonOrganizationStatusID": null,
"PrimaryOrgRoleOrgZoneID": null,
"SetGroupID": null,
"IsExternal": null,
"PersonUsageTypeID": null,
"Department": null,
"Company": null,
"textToSearch": "*",
"columnsToSearch": "%[[][[]%<Conditions><Condition PropertyName=\"OrgRoleOrgZoneFriendlyName\" SearchValue=\"Sales in Dublin\"
Operator=\"EqualTo\" QuerySuffix=\"\" StartGroupString=\"\" EndGroupString=\"\" SearchType=\"String\"/></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 obects matching those values. For people, SearchTerms
encompass the Name
, FriendlyName
, Email
, FirstName
, LastName
, and Login
properties and when used, the API returns all people where the specified search value finds a match in any of those properties. For example, if the search value is set to “Jordan”, the API would return all the following people:
Any person with a first name containing the string
Any person with a last name containing the string
Any person with a login containing the string
Any person with an email address containing the string
The following examples illustrate how to use SearchTerms
to return a subset of people:
1️⃣ Use SearchTerms
to return the Person ID, status, last name, first name, login, email address, risk factor score, and last login date of all people where the search value is set to "jordan."
Code Block |
---|
{
"IncludedProperties": [
"PersonID",
"Active",
"LastName",
"FirstName",
"Login",
"Email",
"RiskFactorTotal",
"LastLoginDate"
],
"Parameters": {
"ExternalApprovalID": null,
"GroupID": null,
"Active": null,
"CompanyID": null,
"CoreIdentityID": null,
"ManagementRoleID": null,
"OrgRoleID": null,
"OrgRoleOrgZoneID": null,
"OrgZoneID": null,
"OwnerAssigneeID": null,
"PersonOrganizationStatusID": null,
"PrimaryOrgRoleOrgZoneID": null,
"SetGroupID": null,
"IsExternal": null,
"PersonUsageTypeID": null,
"Department": null,
"Company": null,
"textToSearch": "*",
"columnsToSearch": "%[[][[]%<Conditions><Condition PropertyName=\"SearchTerms\" SearchValue=\"jordan\" Operator=\"EqualTo\"
QuerySuffix=\"\" StartGroupString=\"\" EndGroupString=\"\" SearchType=\"String\"/></Conditions>"
}
} |
The response includes all people matching the search value. Note the properties where the match occurs.
Code Block |
---|
{ "Tags": [], "Data": [ { "PersonID": 138016, "Active": true, "LastName": "Allison", "FirstName": "Jordan", "Login": "jordanalliso", "Email": "jordana@greatskywest.com", "RiskFactorTotal": 152, "LastLoginDate": "2020-10-12T19:17:38.723" }, { "PersonID": 2234, "Active": true, "LastName": "Armitage", "FirstName": "atinder", "Login": "Jordana.Armitage@eidproducts.onmicrosoft.com", "Email": "Jordana.Armitage@phdnetwork.com", "RiskFactorTotal": 370, "LastLoginDate": "2022-09-16T18:37:35.9" }, { "PersonID": 147269, "Active": true, "LastName": "Ballesteros", "FirstName": "Jordan", "Login": "jordanballe@eidproducts.onmicrosoft.com", "Email": "jordanballe@eidproducts.onmicrosoft.com", "RiskFactorTotal": 0, "LastLoginDate": null }, { "PersonID": 131221, "Active": true, "LastName": "Jordan", "FirstName": "Danny", "Login": "dannyjordan", "Email": "jordand@djenterprises.com", "RiskFactorTotal": 0, "LastLoginDate": null }, { "PersonID": 192191, "Active": true, "LastName": "Jordan", "LastLoginDate" "FirstName": "Hal", ], "ParametersLogin": { "haljordan", "textToSearch": "*", "columnsToSearchEmail": "%[[][[]%<Conditions><Condition PropertyName=\"SearchTerms\" SearchValue=\"jordan\" Operator=\"EqualTo\" QuerySuffix=\"\"hal@glcorps.com", StartGroupString=\"\" EndGroupString=\"\" Index=\"0\" SearchType=\"String\"/></Conditions>"RiskFactorTotal": 0, } } |
Sample Response
Code Block | ||
---|---|---|
| ||
{ "Tags": [], "DataLastLoginDate": [null {} ], "PersonIDOutParameters": 138016, "Active": true, [] } |
2️⃣ Return all people belonging to the “Sales in Dublin” Business Role and Location with a SearchTerm
match equal to "Steve."
Code Block |
---|
{ "IncludedProperties": [ "PersonID", "Active", "LastName", "FirstName", "Login", "LastNameEmail": "Allison", "FirstNameRiskFactorTotal":, "JordanLastLoginDate" ], "Parameters": { "LoginExternalApprovalID": "jordanalliso"null, "EmailGroupID": "jordana@greatskywest.com", null, "RiskFactorTotalActive": 152null, "LastLoginDateCompanyID": "2020-10-12T19:17:38.723"null, "CoreIdentityID": }null, { "ManagementRoleID": null, "PersonIDOrgRoleID": 2234null, "ActiveOrgRoleOrgZoneID": truenull, "LastNameOrgZoneID": "Armitage", null, "FirstNameOwnerAssigneeID": "atinder", null, "LoginPersonOrganizationStatusID": "Jordana.Armitage@eidproducts.onmicrosoft.com", null, "EmailPrimaryOrgRoleOrgZoneID": "Jordana.Armitage@phdnetwork.com", null, "RiskFactorTotalSetGroupID": 370null, "IsExternal": null, "LastLoginDate": "2022-09-16T18:37:35.9" "PersonUsageTypeID": null, "Department": }null, "Company": null, { "textToSearch": "*", "PersonIDcolumnsToSearch": 147269, "%[[][[]%<Conditions><Condition PropertyName=\"OrgRoleOrgZoneFriendlyName\" SearchValue=\"Sales in Dublin\" "Active": true, "LastName": "Ballesteros", Operator=\"EqualTo\" QuerySuffix=\" AND \" "FirstName": "Jordan",StartGroupString=\"\" EndGroupString=\"\" Index=\"0\" "Login": "jordanballe@eidproducts.onmicrosoft.com", SearchType=\"EmailString\":/><Condition "jordanballe@eidproducts.onmicrosoft.com", "RiskFactorTotal": 0,PropertyName=\"SearchTerms\" SearchValue=\"Steve\" Operator=\"EqualTo\" "LastLoginDate": null }, QuerySuffix=\"\" StartGroupString=\"\" { EndGroupString=\"\" Index=\"0\" SearchType=\"String\"/></Conditions>" "PersonID": 131221, "Active": true, "LastName": "Jordan", "FirstName": "Danny", "Login": "dannyjordan", "Email": "jordand@djenterprises.com", "RiskFactorTotal": 0, "LastLoginDate": null }, { "PersonID": 192191, "Active": true, "LastName": "Jordan", "FirstName": "Hal", "Login": "haljordan", "Email": "hal@glcorps.com", "RiskFactorTotal": 0, "LastLoginDate": null } ], "OutParameters": [] } |
Post /GetAllSearchAdvanced
This endpoint returns information about one or more people within the organization.
A valid OAuth 2.0 Bearer token is required.
URL
Code Block |
---|
POST https://<FQDN_Of_Your_EmpowerID_Web_Server>/api/webui/v1/PersonView/GetAllSearchAdvanced} } |
Person Properties
The below table includes Person Properties that can be added to IncludedProperties
.
Property | Returns |
---|---|
PersonID
| The PersonID of the person |
FriendlyName
| The Friendly Name of the person
|
Name
| The full name of the person |
Login
| The EmpowerID login for the person |
| The email address of the person
|
EmailAlias
| The email alias of the person
|
PersonalEmail
| The personal email address of the person
|
ResourceID
| The ResourceID of the person |
PrimaryOrgRoleOrgZoneID
| The ID of the person’s primary Business Role and Location |
PersonGUID
| The unique identifier for the person |
Active
|
|
PersonalTitle
| The personal title
|
FirstName
| The person’s first name |
MiddleName
| The person’s middle name
|
LastName
| The person’s last name |
SecondLastName
| The person’s second last name
|
GenerationalSuffix
| The person’s generational suffix
|
BirthName
| The person’s birth name
|
Initials
| The person’s initials
|
Title
| The person’s title
|
AboutMe
| The information in the
|
StreetAddress
| The person’s street address
|
StreetAddress2
| The second line of street address
|
City
| The person’s city
|
State
| The person’s state
|
PostalCode
| The person’s postal code
|
Country
| The person’s country
|
Province
| The person’s province
|
Company
| The person’s company
|
Division
| The person’s division
|
Department
| The person’s department
|
DepartmentNumber
| The person’s department number
|
Office
| The person’s office
|
POBox
| The person’s Post Office Box
|
Location
| The person’s location
|
SocialSecurityNumber
| The person’s Social Security Number
|
NationalIdentificationNumber
| The person’s National Identification Number
|
CarLicense
| The person’s vehicle license plate number
|
DriversLicenseNumber
| The person’s driver’s license number
|
Ethnicity
| The person’s ethnicity
|
Gender
| The person’s gender
|
District
| The District for the person
|
Assistant
| The name of the assistant for the person
|
PhotoURL
| The Photo URL for the person
|
IMAddress
| The IM address for the person
|
SIPAddress
| The SIP address for the person
|
IdentityURL
| The Identity URL for a person
|
URLPersonal
| The Personal URL for a person
|
URLBusiness
| The Business URL for a person
|
URLOWA
| The OWA URL for a person
|
Telephone
| The telephone number for the person
|
MobilePhone
| The mobile phone number for the person
|
BusinessPhone
| The business phone number for the person
|
Pager
| The pager number for the person
|
HomeTelephone
| The home telephone number for the person
|
FAX
| The fax number of a person
|
Notes
| Notes about a person
|
MustChangePasswordOnNextLogin
| Specifies whether the person must change their password on their next login
|
LastLoginDate
| Date the person last logged in |
LastPasswordChangedDate
| Date the person’s password was changed |
FirstLoginFailedAttempt
| Date of the first logn failure for the person
|
FailedLoginAttemptsCount
| Number of failed lgoin attempts for the person
|
DisableSSOLogin
| Specifies whether the person can login via SSO
|
LockedUntil
| Date the person is locked out of the system due to login failures
|
Description
| Description of the person
|
ValidFrom
| Date the person account became valid
|
ValidUntil
| Date the person account becomes invalid
|
DateOfBirth
| Birth date of the person
|
CityOfBirth
| Birth city of the person
|
CountryOfBirth
| Birth country of the person
|
NationID
| Nation ID of the person
|
IsOutOfOffice
| Specifies the Out Of Office status of the person
|
EmployeeID
| Employee ID of the person
|
EmployeeIDOther
| Secondary Employee ID of tjhe person
|
ManagerPersonID
| PersonID of the person’s manager
|
EmployeeType
| The person’s Employee type
|
EmployeeTypeOther
| The person’s Secondary Employee type
|
MobilePhoneProviderID
| The ID of the person’s mobile phone provider
|
Status
| The person’s account status
|
LocaleID
| LocaleID of the person’s Locale
|
ProfileManagerLastUpdated
| The date the person’s profile was last updated
|
OrgRoleOrgZoneFriendlyName
| The Friendly Name of the person’s Business Role and Location |
CoreIdentityID
| The ID of the Core Identity linked to the person |
PersonProofingStatusFriendlyName
| The status of the person’s proofing status |
PersonManagerName
| The name of the person’s manager |
TimeConstrain
| Time constraint data for the person XML format |
TimeConstraintActive
| Specifies whether an active time constraint exists for the person
|
AllowLogin
| Specifies whether the person can log in
|
AllowPasswordOperations
| Specifies whether the person can update their passwords
|
AllowAttributeSync
| Specifies whether attribute sync is allowed between the person account and any owned external user accounts
|
AllowOrgRoleOrgZoneReEval
| Specifies whether the Business Role and Location of the person can be re-evaluated
|
LogonNameBeforeDeleted
| The logon name before the person account was deleted
|
Deleted
| Specifies whether the person account has been deleted
|
DeletedDate
| The date the person account was deleted
|
SessionDirtyDate
| The date of the person’s last session
|
RiskFactorTotal
| The total risk factor score associated with the person
|
RiskFactorTotalCalculated
| The date the person’s total risk factor score was calculated |
CreatedDate
| The date and time the person account was created in the system |
ModifiedDate
| The date and time any person attributes were modified for the person |
DisableNotifications
| Specifies whether system notifications are disabled for the person
|
DisableAsApprover
| Specifies whether approval notifications are disabled for the person
|
PreferredFirstName
| The preferred first name of the person
|
PreferredLastName
| The preferred last name of the person
|
ExpectedHireDate
| The expected hire date for the person
|
OriginalHireDate
| The person’s original hire date
|
TerminationDate
| The date the person was terminated from the company
|
OrganizationID
| The ID of the person’s organization |
LoginRequireDeviceRegistration
| Specifies whether the person’s devices must be registered to log in to the Web app
|
RequireSecondFactor
| Specifies whether second factor authentication is required for the person to log in
|
RequireSecondFactorForLDAP
| Specifies whether second factor authentication is required for the person to log in via LDAP
|
RequireSecondFactorForRadius
| Specifies whether second factor authentication is required for the person to log in via RADIUS
|
LastChatStatus
| The last chat status of the person
|
JobCode
| The peson's job code
|
PositionCode
| The person’s position code
|
DefaultHomePage
| The default home page of the Web application for the person
|
RoomNumber
| The person’s room number
|
BusinessCategory
| The business category for the person
|
OrgUnit
| The person’s org unit
|
SearchTerms
| Search terms used to return the person in the search fields of the Web application |
DistinguishedName
| Distinguished name of the person account |
CoreIdentityID
| ID of the person’s Core Identity object
|
ProcessStatus
| Process status for the person’s account
|
ProcessTime
| The date and time the system processed the person’s account |
DisabledDate
| The date the person’s account was disabled
|
OwnerAssigneeID
| Unique identifier of the owner of the person’s account
|
IsExternal
| Specifies whether the person is external to the organization
|
HRNumber
| The person’s HR Number
|
DepartmentType
| The person’s Department Type
|
DepartmentCode
| The person’s Department Code
|
CompanyType
| The person’s company type
|
CompanyCode
| The company code for the person
|
CostCenter
| The cost center for the person
|
BusinessUnit
| The person’s business unit
|
PositionID
| The ID of the person’s position
|
SiteCode
| The Site Code for the person’s site
|
SiteName
| The Site Name for the person’s site
|
WorkingCompany
| The Working Company of the person
|
PreferredLanguage
| The person’s preferred language
|
SuspensionStartDate
| The suspension start date for the person
|
SuspensionEndDate
| The suspension end date for the person
|
IsContingentWorker
| Specifies whether the person is a contingent worker
|
IsFullTimeEmployee
| Specifies whether the person is a full-time employee
|
WorkingDaysPerWeek
| The number of days per week the person works
|
StandardHours
| The standard hours for the person
|
WorkLocation
| The person’s work location
|
BusinessTitle
| The person’s Business Title
|
Region
| The person’s region
|
IsEmailAcountRequired
| Specifies whether an email account is required for the person
|
JobCodeDescription
| The person’s Department Code
|
JobLocationName
| The person’s Department Code
|
County
| The person’s county
|
StreetAddress3
| The third line of the person’s Street Address
|
PreferredState
| The person’s preferred state
|
ThirdName
| The person’s third name
|
CostCenterDescription
| The cost center description for the person
|
CompanyDescription
| The person’s company description
|
LeaveOfAbsenseActualReturnDate
| The date the person returned from a leave of absence
|
LeaveOfAbsenseExpectedReturnDate
| The date the person is expected to return from a leave of absence
|
LeaveOfAbsenseStartDate
| The date the person starts a leave of absense
|
LeaveOfAbsenseEndDate
| The date the person’s leave of absence ends
|
WorkOrderStartDate
| The work order start date for a person
|
WorkOrderEndDate
| The work order end date for a person
|
WorkOrderId
| The work order ID for a person
|
EffectiveStartDate
| The effective start date for a person
|
EffectiveEndDate
| The effective end date for a person
|
IsPrimary
| Specifies whether the account is the primary person
|
ExcludeFromResourceEntitlement
| Specifies whether the person is excluded from recieving any resource entitlements granted by provisioning policies.
|
IsSaaS
| Specifies whether the person is a SaaS account |
SendEmailAsEncrypted
| Specifies whether email is to be sent encrypted
|
PreferredDataLocation
| The preferred data location for a p
|
ChangeTS
| The date and time a change occured on the person |
OofEndDate
| Date and time a person’s Out of Office status ends
|
OofInternalMsg
| Out of Office message sent to internal users
|
OofExternalMsg
| Out of Office message sent to external users
|
OofAudience
| Out of Office audience
|
OofStatus
| Out of Office status
|
OofStartDate
| Date and time the person’s Out of Office status begins
|
BotConversationReferenceID
| Unique identifier of the person’s BOT conversation
|
CitizenNationID
| Nation ID for the person
|
Currency
| Currency used by the person
|
DefaultCurrency
| Default currency for the person
|
Div | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
IN THIS ARTICLE
|