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	✔️	✔️

Request

URI

POST

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

COPY

Request Body

SearchUsersInIdpRequest of type(s) application/json

Required

"SearchUsersInIdpRequest Object"

string

idpId

Optional

Idp id to search users into it. Must not be null or blank.

integer As int32 As int32

pageLimit

Optional

Constraints: minimum: 1 maximum: 200

Maximum number of users to return in response. Default value is 200.

integer As int32 As int32

pageStart

Optional

Constraints: minimum: 1

Start index for querying users. Default value is 1.

string

domain

Optional

Optionally filtered by domain.

string

searchTerm

Required

Constraints: minLength: 0 maxLength: 120

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.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns PagedPostResponseBaseUserDto of type(s) application/json

{
    "itemsPerPage": 25,
    "totalResults": 2000,
    "startIndex": 5,
    "results": [
        {
            "firstName": "string",
            "lastName": "string",
            "userId": "string",
            "email": "string",
            "username": "string",
            "domain": "string",
            "accessible": false,
            "acct": "string",
            "idpId": "string"
        }
    ]
}

integer As int32 As int32

itemsPerPage

Optional

Number of items per page.

integer As int32 As int32

totalResults

Optional

Total number of results if available

integer As int32 As int32

startIndex

Optional

Start index of the results.

array of object

results

Optional

Partial list of returned results.

401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

403

Only privileged operators can search in an IDP that they do not belong to.

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

404

The requested resource could not be found

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

409

The request could not be processed due to a conflict

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/csp/gateway/am/api/v2/users/search

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

User Operations

POST

Search Users In Idp By Names And Email Using POST

GET