Search Users In Idp By Names And Email Using POST

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

Show optional properties

{
    "searchTerm": "string"
}
{
    "domain": "string",
    "idpId": "string",
    "pageLimit": 0,
    "pageStart": 0,
    "searchTerm": "string"
}
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 As int32
pageLimit
Optional

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

integer As int32 As int32
pageStart
Optional

Start index for querying users. Default value is 1.

string
searchTerm
Required

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.
Responses
200

OK

Returns PagedPostResponseBaseUserDto of type(s) application/json 
{
    "itemsPerPage": 25,
    "results": [
        {
            "accessible": false,
            "acct": "string",
            "domain": "string",
            "email": "string",
            "firstName": "string",
            "idpId": "string",
            "lastName": "string",
            "userId": "string",
            "username": "string"
        }
    ],
    "startIndex": 5,
    "totalResults": 2000
}
integer As int32 As int32
itemsPerPage
Optional

Number of items per page.

array of BaseUserDto
results
Optional

Partial list of returned results.

integer As int32 As int32
startIndex
Optional

Start index of the results.

integer As int32 As int32
totalResults
Optional

Total number of results if available


401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

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 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


404

The requested resource could not be found

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

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 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

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 
{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


On This Page
User Operations
GET
Get User Custom Roles By User Id And Organization Id Using GET
GET
Get User Groups By User Email And Organization Id Using GET
GET
Get User Groups By User Id And Organization Id Using GET
GET
Get User Info By User Id And Organization Id Using GET
GET
Get User Organization Roles By User Id And Organization Id Using GET
GET
Get User Service Roles By User Id And Organization Id Using GET
POST
Search Users In Idp By Names And Email Using POST
PATCH
Update User Roles By User Id And Organization Id Using PATCH