search user in elasticsearch

ApiScope: search.user.read
API Scope Level: ServiceSubscriberScope

Query Parameters

searchText string required
resultSize int32 required

Responses

• 200
• 400
• 401
• 403
• 500

---

OK

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
users object[]
Array [
dealerAssociateId string
fname string
lname string
userName string
phone string
textNumber string
emailAddress string
roleName string
dmsId string
dealerDepartmentId string
dealerDepartmentUUID string
dealerDepartmentName string
userUuid string
isValid boolean
isValidUser boolean
dealerAssociateUUID string
latestInviteStatus string
latestInviteDate string
dealerId string
dealerName string
dealerUuid string
roleUuid string
outOfOffice boolean
outOfOfficeStartDate string
]
totalPages int32
totalElements int64

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "users": [
    {
      "dealerAssociateId": "string",
      "fname": "string",
      "lname": "string",
      "userName": "string",
      "phone": "string",
      "textNumber": "string",
      "emailAddress": "string",
      "roleName": "string",
      "dmsId": "string",
      "dealerDepartmentId": "string",
      "dealerDepartmentUUID": "string",
      "dealerDepartmentName": "string",
      "userUuid": "string",
      "isValid": true,
      "isValidUser": true,
      "dealerAssociateUUID": "string",
      "latestInviteStatus": "string",
      "latestInviteDate": "string",
      "dealerId": "string",
      "dealerName": "string",
      "dealerUuid": "string",
      "roleUuid": "string",
      "outOfOffice": true,
      "outOfOfficeStartDate": "string"
    }
  ],
  "totalPages": 0,
  "totalElements": 0
}

Bad Request

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Unauthorized

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Forbidden

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Internal Server Error

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

GET /v2/search/user

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/manage

Username

Password

searchText — query required

resultSize — query required

curl / cURL

curl -L -X GET '/manage/v2/search/user' \
-H 'Accept: application/json'

python / requests

curl -L -X GET '/manage/v2/search/user' \
-H 'Accept: application/json'

go / native

curl -L -X GET '/manage/v2/search/user' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET '/manage/v2/search/user' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET '/manage/v2/search/user' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET '/manage/v2/search/user' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET '/manage/v2/search/user' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET '/manage/v2/search/user' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET '/manage/v2/search/user' \
-H 'Accept: application/json'