Search for principal information

Search for principal information. Search criteria are combined using the 'or' operator

Body required
application/json

The principal information search request

identifier
string

The identifier of the principal
role
string

The role of the principal
sortedBy
array of objects (Sort By)

How to sort the results of the search
strictSearch
boolean

By default, search on identifier/roles is based on contain. If enabled, strict equality of the result must be found
pageIndex
integer

Which page result to display
pageSize
integer

How many results to display per page
withCount
boolean

Whether to include the total number of results in the response
Responses
  • 200 The principal information search results
    results
    array of objects (Principal information) required
    pageIndex
    integer required

    The current page index
    pageSize
    integer required

    The current number of returned element per page
    hasMore
    boolean required

    Whether there are more results to display (on another page)
    count
    integer

    The total number of results (if withCount was set to true in the query)
  • 204 No content
  • 400 Unable to find the Principal Information
  • 401 Authentication error
  • 403 Forbidden action
  • 500 Unexpected internal server error