Search Users In Idp By Names And Email Using POST
Search users in idp by names and email.
Access Policy
Role | User Accounts | Service Accounts (Client Credentials Applications) |
---|---|---|
Organization Member | ✔️ | ✔️ |
Organization Admin | ✔️ | ✔️ |
Organization Owner | ✔️ | ✔️ |
Show optional properties
{
"searchTerm": "string"
}
{
"domain": "string",
"idpId": "string",
"pageLimit": 0,
"pageStart": 0,
"searchTerm": "string"
}
Optionally filtered by domain.
Idp id to search users into it. Must not be null or blank.
Maximum number of users to return in response. Default value is 200.
Start index for querying users. Default value is 1.
Search criteria to search for users by their first name, last name and email. Must not be null or blank. Max search length is 120 characters.
OK
"PagedPostResponseBaseUserDto Object"
Number of items per page.
Partial list of returned results.
Start index of the results.
Total number of results if available
The user is not authorized to use the API
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
Only privileged operators can search in an IDP that they do not belong to.
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
The requested resource could not be found
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
The request could not be processed due to a conflict
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
The user has sent too many requests
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
An unexpected error has occurred while processing the request
"CspErrorResponse Object"
cspErrorCode
errorCode
message
moduleCode
requestId
statusCode
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"searchTerm:"string"}' https://{api_host}/csp/gateway/am/api/v2/users/search