Documentation forAccess Rights Manager

Search Account APIs

Search Accounts (GET)

Performs a search for user/group accounts.

Route

URI

/api/v1/SearchAccount/SearchAccounts

Method

GET

Result

JSON – A JsonResult of an array containing the search results with enriched display information.

Parameters

Name

Type

Mandatory

Description

searchArguments

SearchArguments

No

has the following arguments

Example

GET http://localhost/api/v1/SearchAccount/SearchAccounts

Search Accounts Old (POST)

Search Accounts Old.

Route

URI

/api/v1/SearchAccount/SearchAccounts

Method

POST

Result

JSON – ActionResult

Parameters

Name

Type

Mandatory

Description

searchArguments

SearchArguments

No

 

Example

POST http://localhost/api/v1/SearchAccount/SearchAccounts

Search Explicit Approval Role Definitions (GET)

See <see cref="SearchAccounts"/>, but returns <see cref="ExplicitApprovalRoleDefinition"/>s instead of <see cref="AccountModel"/>s.

Route

URI

/api/v1/SearchAccount/SearchExplicitApprovalRoleDefinitions

Method

GET

Result

JSON – ActionResult

Parameters

Name

Type

Mandatory

Description

searchString

string

No

 

searchInCurrentDomainOnly

bool

No

 

searchDataOwnerResourcesOnly

bool

No

 

Example

GET http://localhost/api/v1/SearchAccount/SearchExplicitApprovalRoleDefinitions

Search Generic Accounts As Grid Entries (GET)

See <see cref="SearchAccounts"/>, but returns <see cref="AccountWithImageGridEntry"/>s instead of <see cref="AccountModel"/>s.

Route

URI

/api/v1/SearchAccount/SearchGenericAccountsAsGridEntries

Method

GET

Result

JSON – ActionResult

Parameters

Name

Type

Mandatory

Description

searchString

string

No

 

searchActiveDirectoryAccountsOnly

bool

No

 

Example

GET http://localhost/api/v1/SearchAccount/SearchGenericAccountsAsGridEntries

Search Light Account Objects (GET)

See <see cref="SearchAccounts"/>, but returns <see cref="LightAccountObject"/>s instead of <see cref="AccountModel"/>s.

Route

URI

/api/v1/SearchAccount/SearchLightAccountObjects

Method

GET

Result

JSON – ActionResult

Parameters

Name

Type

Mandatory

Description

searchString

string

No

 

searchInCurrentDomainOnly

bool

No

 

Example

GET http://localhost/api/v1/SearchAccount/SearchLightAccountObjects

Search User Accounts As Grid Entries (GET)

See <see cref="SearchAccounts"/>, but returns <see cref="UserAccountWithImageGridEntry"/>s instead of <see cref="AccountModel"/>s. class AccountWithImageGridEntry can be used instead, if needed => just set IsGroup = false, because all returned accounts are users

Route

URI

/api/v1/SearchAccount/SearchUserAccountsAsGridEntries

Method

GET

Result

JSON – ActionResult

Parameters

Name

Type

Mandatory

Description

searchString

string

No

 

Example

GET http://localhost/api/v1/SearchAccount/SearchUserAccountsAsGridEntries