Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Post /GetAllSearchAdvanced
Send a POST request to the GetAllSearchAdvanced() method on the ManagementRoleView object to return information about one or more Management Roles. The information included in the response depends on the range of 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/ManagementRoleView/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 Management Role property.
Included Properties
Use IncludedProperties to return one or more role properties.
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 Management Roles returned by the endpoint.
| Expand | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||
|
columnsToSearch
The columnsToSearch body parameter is used to return Management Roles meeting one or more conditions. Each condition specifies a property with a specific value to search. For example, to return a list of Management Roles 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=\"FriendlyName\" SearchValue=\"deprecated\" Operator=\"EqualTo\" QuerySuffix=\" AND \" StartGroupString=\"\" EndGroupString=\"\" Index=\"0\" SearchType=\"String\"/><Condition PropertyName=\"Description\" SearchValue=\"All Access\" 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 groups matching the search conditions. Attributes returned for each record are set by the properties specified in IncludedProperties.
1️⃣ Set the HighSecurity parameter to true, the PersonID parameter to the GUID of an EmpowerID Person and the ShowDirectPersonAssignmentsOnly parameter to true to return a list of Management Roles classified as “high security” where the person has been directly assigned to those roles.
| Code Block | ||
|---|---|---|
| ||
{
"IncludedProperties": [
"FriendlyName",
"ManagementRoleTypeFriendlyName",
"Description",
"OwnerAssigneeFriendlyName",
"IsHighSecurity",
"RiskFactorTotal"
],
"Parameters": {
"HighSecurity": true,
"LinkedToApplicationID": null,
"ManagementRoleDefinitionID": null,
"ManagementRoleGUIDInherited": null,
"NotAssignedToPersonID": null,
"OrgZoneID": null,
"OwnerPersonGUID": null,
"PersonID": null,
"ShowDirectPersonAssignmentsOnly": 1,
"ShowTRBACRoles": null,
"textToSearch": "AdvancedSearch",
"columnsToSearch": "%[[][[]%<Conditions/>",
"pageLength": 10,
"resourceTags": null,
"start": 0,
"totalCount": null
}
} |
2️⃣ Set the OwnerPersonGUID parameter to the GUID of an EmpowerID Person to return roles owned by that person.
| Code Block |
|---|
{
"IncludedProperties": [
"FriendlyName",
"ManagementRoleTypeFriendlyName",
"Description",
"OwnerAssigneeFriendlyName",
"IsHighSecurity",
"RiskFactorTotal"
],
"Parameters": {
"HighSecurity": null,
"LinkedToApplicationID": null,
"ManagementRoleDefinitionID": null,
"ManagementRoleGUIDInherited": null,
"NotAssignedToPersonID": null,
"OrgZoneID": null,
"OwnerPersonGUID": "d399765d-fcd7-45c9-913f-2b0c9e65f8b7",
"PersonID": null,
"ShowDirectPersonAssignmentsOnly": 1,
"ShowTRBACRoles": null,
"textToSearch": "AdvancedSearch",
"columnsToSearch": "%[[][[]%<Conditions/>",
"pageLength": 10,
"resourceTags": null,
"start": 0,
"totalCount": null
}
} |
3️⃣ Use columnsToSearch to return “Feature Set (UI)” Management Roles. Note the PropertyName for the search condition is set to ManagementRoleTypeID, SearchValue is set to 7, the Operator is set to EqualTo and the SearchType is Int.
| Code Block |
|---|
{
"IncludedProperties": [
"FriendlyName",
"ManagementRoleTypeFriendlyName",
"Description",
"OwnerAssigneeFriendlyName",
"IsHighSecurity",
"RiskFactorTotal"
],
"Parameters": {
"HighSecurity": true,
"LinkedToApplicationID": null,
"ManagementRoleDefinitionID": null,
"ManagementRoleGUIDInherited": null,
"NotAssignedToPersonID": null,
"OrgZoneID": null,
"OwnerPersonGUID": null,
"PersonID": null,
"ShowDirectPersonAssignmentsOnly": 1,
"ShowTRBACRoles": null,
"textToSearch": null,
"columnsToSearch": "%[[][[]%<Conditions><Condition PropertyName=\"ManagementRoleTypeID\" SearchValue=\"7\" Operator=\"EqualTo\"
QuerySuffix=\"\" StartGroupString=\"\" EndGroupString=\"\" Index=\"0\" SearchType=\"Int\"/></Conditions>",
"pageLength": 10,
"resourceTags": null,
"start": 0,
"totalCount": null
}
} |
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 Management Roles, SearchTerms include the Name, FriendlyName, Email, DistinguishedName, and Description properties. When used, the API returns all roles where the specified search value finds a match in any of those properties. For example, if the search value is set to “Doc”, the API would return all the following roles:
Any Management Role with a match in the name
Any Management Role with a match in the friendly name
Any Management Role with a match in the email address
Any Management Role with a match in the Distinguished Name
Any Management Role with a match in the description
The following examples illustrate how to use SearchTerms to return a subset of roles:
1️⃣ Use SearchTerms to return the Friendly Name, Management Role Type Friendly Name, Description and Risk Factor Total for Management Roles where the search value is set to "Help"
| Code Block |
|---|
{
"IncludedProperties": [
"FriendlyName",
"ManagementRoleTypeFriendlyName",
"Description",
"RiskFactorTotal"
],
"Parameters": {
"HighSecurity": true,
"LinkedToApplicationID": null,
"ManagementRoleDefinitionID": null,
"ManagementRoleGUIDInherited": null,
"NotAssignedToPersonID": null,
"OrgZoneID": null,
"OwnerPersonGUID": null,
"PersonID": null,
"ShowDirectPersonAssignmentsOnly": null,
"ShowTRBACRoles": null,
"textToSearch": "AdvancedSearch",
"columnsToSearch": "%[[][[]%<Conditions><Condition PropertyName=\"SearchTerms\" SearchValue=\"Help\" Operator=\"EqualTo\" QuerySuffix=\"\"
StartGroupString=\"\" EndGroupString=\"\" Index=\"0\" SearchType=\"String\"/></Conditions>",
"pageLength": 10,
"resourceTags": null,
"start": 0,
"totalCount": null
}
} |
Sample Responses
| Tabs macro | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
[{"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 \"FriendlyName\": \"ACT-Account-Password-Helpdesk-SAP\",\r\n \"ManagementRoleTypeFriendlyName\": \"Activity (ACT)\",\r\n \"Description\": \"ACT-Account-Password-Helpdesk-SAP - Can perform user account password resets and unlocks for all SAP ABAP accounts\",\r\n \"OwnerAssigneeFriendlyName\": null,\r\n \"IsHighSecurity\": false,\r\n \"RiskFactorTotal\": 0\r\n }, \r\n {\r\n \"FriendlyName\": \"Password Helpdesk for All People\",\r\n \"ManagementRoleTypeFriendlyName\": \"Role Bundle\",\r\n \"Description\": \"Password Helpdesk for All People - can perform password helpdesk resets for all people\",\r\n \"OwnerAssigneeFriendlyName\": null,\r\n \"IsHighSecurity\": false,\r\n \"RiskFactorTotal\": 0\r\n },\r\n {\r\n \"FriendlyName\": \"SAP Identity Helpdesk\",\r\n \"ManagementRoleTypeFriendlyName\": \"Role Bundle\",\r\n \"Description\": \"Has a limited UI experience focused on SAP tasks\",\r\n \"OwnerAssigneeFriendlyName\": null,\r\n \"IsHighSecurity\": false,\r\n \"RiskFactorTotal\": 0\r\n },\r\n {\r\n \"FriendlyName\": \"Training Helpdesk Role\",\r\n \"ManagementRoleTypeFriendlyName\": \"Generic\",\r\n \"Description\": \"Training Helpdesk Role\",\r\n \"OwnerAssigneeFriendlyName\": null,\r\n \"IsHighSecurity\": false,\r\n \"RiskFactorTotal\": 0\r\n },\r\n {\r\n \"FriendlyName\": \"UI-Account-Password-Helpdesk\",\r\n \"ManagementRoleTypeFriendlyName\": \"Feature Set (UI)\",\r\n \"Description\": \"UI-Account-Password-Helpdesk - access to perform assisted password resets and unlocks\",\r\n \"OwnerAssigneeFriendlyName\": null,\r\n \"IsHighSecurity\": false,\r\n \"RiskFactorTotal\": 0\r\n },\r\n {\r\n \"FriendlyName\": \"UI-Person-Password-Helpdesk\",\r\n \"ManagementRoleTypeFriendlyName\": \"Feature Set (UI)\",\r\n \"Description\": \"UI-Person-Password-Helpdesk - access to perform assisted password resets and unlocks\",\r\n \"OwnerAssigneeFriendlyName\": null,\r\n \"IsHighSecurity\": false,\r\n \"RiskFactorTotal\": 0\r\n }\r\n ],\r\n \"OutParameters\": [\r\n {\r\n \"Name\": \"totalCount\",\r\n \"Value\": 6\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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Account PropertiesThe below table includes Account Properties that can be added to
|
| Div | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
IN THIS ARTICLE
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|