Search APIs

Search Accounts (POST)

Searches for accounts based on criteria.

Route

URI	/api/v1/searchAccount/SearchAccounts
Method	POST
Result	JSON – Array of AccountSearchResult

Request Payload

AccountSearchCriteria object:

Property	Type	Mandatory	Description
searchTerm	string	Yes	Text to search for in account names
accountType	string	No	Filter by account type (user, group)
provider	string	No	Filter by technology provider
maxResults	int	No	Maximum number of results to return

Response Structure

Returns array of AccountSearchResult objects based on AccountModel with search match details.

Example Request

POST http://localhost/api/v1/searchAccount/SearchAccounts
Content-Type: application/json

{
  "searchTerm": "john",
  "accountType": "user",
  "provider": "AD",
  "maxResults": 50
}

Example Response

[
  {
    "UriKey": "john.doe@contoso.com",
    "DisplayName": "John Doe",
    "ResourceTypeGuid": "123e4567-e89b-12d3-a456-426614174000",
    "SerializedAccountId": "S-1-5-21-...",
    "IsGroup": false,
    "Description": "Software Engineer",
    "TypeId": 1,
    "Provider": "AD"
  },
  {
    "UriKey": "john.smith@contoso.com",
    "DisplayName": "John Smith",
    "ResourceTypeGuid": "123e4567-e89b-12d3-a456-426614174000",
    "SerializedAccountId": "S-1-5-21-...",
    "IsGroup": false,
    "Description": "Project Manager",
    "TypeId": 1,
    "Provider": "AD"
  }
]

Search User Accounts As Grid Entries (POST)

Searches for user accounts and returns results formatted for grid display.

Route

URI	/api/v1/searchaccount/SearchUserAccountsAsGridEntries
Method	POST
Result	JSON – Array of GridEntryModel

Request Payload

UserAccountSearchCriteria object:

Property	Type	Mandatory	Description
SearchTerm	string	No	Text to search in account names
PageNumber	int	No	Page number for pagination
PageSize	int	No	Number of results per page
SortBy	string	No	Field to sort by
Filters	object	No	Additional filter criteria

Response Structure

Returns array of GridEntryModel objects for display in grid/table format.

Example Request

POST http://localhost/api/v1/searchaccount/SearchUserAccountsAsGridEntries
Content-Type: application/json

{
  "SearchTerm": "john",
  "PageNumber": 1,
  "PageSize": 50,
  "SortBy": "DisplayName"
}

Example Response

[
  {
    "Id": "123e4567-e89b-12d3-a456-426614174001",
    "DisplayName": "John Doe",
    "Type": "User",
    "Email": "john.doe@contoso.com",
    "Department": "IT"
  }
]

Search Generic Accounts As Grid Entries (POST)

Searches for generic accounts and returns results formatted for grid display.

Route

URI	/api/v1/SearchAccount/searchGenericAccountsAsGridEntries
Method	POST
Result	JSON – Array of GridEntryModel

Request Payload

GenericAccountSearchCriteria object:

Property	Type	Mandatory	Description
SearchTerm	string	No	Text to search in account names
AccountType	string	No	Type of generic account
PageNumber	int	No	Page number for pagination
PageSize	int	No	Number of results per page

Example Request

POST http://localhost/api/v1/SearchAccount/searchGenericAccountsAsGridEntries
Content-Type: application/json

{
  "SearchTerm": "service",
  "AccountType": "ServiceAccount",
  "PageNumber": 1,
  "PageSize": 50
}

Search Explicit Approval Role Definitions (POST)

Searches for explicit approval role definitions.

Route

URI	/api/v1/searchaccount/SearchExplicitApprovalRoleDefinitions
Method	POST
Result	JSON – Array of ApprovalRoleDefinition

Request Payload

ApprovalRoleSearchCriteria object:

Property	Type	Mandatory	Description
SearchTerm	string	No	Text to search in role definitions
RoleType	string	No	Type of approval role
IncludeInactive	bool	No	Include inactive roles

Example Request

POST http://localhost/api/v1/searchaccount/SearchExplicitApprovalRoleDefinitions
Content-Type: application/json

{
  "SearchTerm": "manager",
  "RoleType": "Explicit",
  "IncludeInactive": false
}

Search Resources (POST)

Searches for resources based on criteria.

Route

URI	/api/v1/search/resources
Method	POST
Result	JSON – Array of ResourceSearchResult

Request Payload

ResourceSearchCriteria object:

Property	Type	Mandatory	Description
searchTerm	string	No	Text to search in resource names
resourceType	string	No	Type of resource to search
organizationId	Guid	No	Filter by organization
includeChildren	bool	No	Include child resources in search

Response Structure

Returns array of ResourceSearchResult objects matching the search criteria.

Example Request

POST http://localhost/api/v1/search/resources
Content-Type: application/json

{
  "searchTerm": "folder",
  "resourceType": "FileSystem",
  "includeChildren": true
}

Example Response

[
  {
    "ResourceId": "123e4567-e89b-12d3-a456-426614174001",
    "Name": "Shared Folder",
    "Path": "/Shared",
    "ResourceType": "FileSystem"
  }
]