Search customer user.

Get customer user details in the system.

SecurityoAuth2
Request
path Parameters
customerId
required
string

Customer unique identifier and which is associated with the token legal entity.

query Parameters
page
number

page index. If page index is not provided then the default index i.e 1 will be applicable.

size
number

page size.If page size is not provided then the default index i.e 10 will be applicable.

Request Body schema: application/json
required

Search criteria

loginId
string

Unique identifier.

firstName
string

User first name.

lastName
string

last name of user

email
string

users email id

phoneNumber
string

User contact number

status
string

Current status of the user

shortName
string

The name of the legal entity associated with the user.

Responses
200

OK

400

Bad request

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

500

Internal server error

503

Service unavailable

default

Get user details based upon search criteria

post/api/user-management/v1/customers/{customerId}/users//users/search
Request samples
application/json
{
  • "loginId": "user123",
  • "firstName": "john",
  • "lastName": "T.",
  • "email": "user123@gamil.com",
  • "phoneNumber": "9389989658",
  • "status": "Active",
  • "shortName": "CORP"
}
Response samples
application/json
{
  • "totalElements": 1212,
  • "totalPages": 40,
  • "size": 50,
  • "page": 1,
  • "data": [
    ]
}