[{"label":"Latest (v1.0)","version":"latest"}]
csp

Search Users In IDP By Names And Email

Description

Search users in idp by names and email.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Member ✔️ ✔️
Organization Owner ✔️ ✔️

Request

Request

URL

URL


post
https://{api_host}/csp/gateway/am/api/v2/users/search
Copy

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response 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.


array of BaseUserDto
results Optional

Partial list of returned results.


integer as int32
startIndex Optional

Start index of the results.


integer as int32
totalResults Optional

Total number of results if available

Errors

Errors

401

The user is not authorized to use the API


403

Only platform operator or read-only operator can search in an IDP that they do not belong to.


404

The requested resource could not be found


409

The request could not be processed due to a conflict


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

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

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_member,org_owner
x-slo-tier: TIER2


Feedback

Was this page helpful?