[{"label":"Latest (v1.0)","version":"latest"}]
csp
Search Users In IDP By Names And Email
DescriptionSearch users in idp by names and email.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Member | ✔️ | ✔️ |
| Organization Admin | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
Request
URLURL
https://{api_host}/csp/gateway/am/api/v2/users/search
Request Body
Request Body
SearchUsersInIdpRequest
of mimetype application/json
Required
{
"searchTerm": "string"
}
string
searchTerm
Required
Search criteria to search for users by their first name, last name and email. Must not be null or blank.
string
domain
Optional
Optionally filtered by domain.
string
idpId
Optional
Idp id to search users into it. Must not be null or blank.
integer as int32
pageLimit
Optional
Maximum number of users to return in response. Default value is 200.
integer as int32
pageStart
Optional
Start index for querying users. Default value is 1.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
PagedPostResponseBaseUserDto
of type application/json
{
"itemsPerPage": 25,
"startIndex": 5,
"totalResults": 2000
}
integer as int32
itemsPerPage
Optional
Number of items per page.
integer as int32
startIndex
Optional
Start index of the results.
integer as int32
totalResults
Optional
Total number of results if available
Errors
CspErrorResponse
401
The user is not authorized to use the API
CspErrorResponse
403
Only privileged operators can search in an IDP that they do not belong to.
CspErrorResponse
404
The requested resource could not be found
CspErrorResponse
409
The request could not be processed due to a conflict
CspErrorResponse
429
The user has sent too many requests
CspErrorResponse
500
An unexpected error has occurred while processing the request
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"domain":"string","idpId":"string","pageLimit":0,"pageStart":0,"searchTerm":"string"}' https://{api_host}/csp/gateway/am/api/v2/users/search
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_member,org_admin,org_owner
x-slo-tier: TIER2
[{"label":"Latest (v1.0)","version":"latest"}]
csp
