Skip to main content
POST
/
v2
/
UserSearch
Search users
curl --request POST \
  --url http://localhost:3000/v2/UserSearch \
  --header 'Content-Type: application/json' \
  --header 'X-Bunker-Token: <api-key>' \
  --data '
{
  "mode": "login",
  "identity": "<string>",
  "unlockuuid": "<string>",
  "request_metadata": {}
}
'
{
  "status": "ok",
  "rows": [
    {
      "token": "<string>",
      "profile": {},
      "version": 123,
      "finaltime": 123,
      "slidingtime": 123,
      "expirationtime": 123,
      "grouproles": [
        {}
      ]
    }
  ]
}

Authorizations

X-Bunker-Token
string
header
required

API token for authentication

Body

application/json
mode
enum<string>
required

Mode of user identification

Available options:
login,
token,
email,
phone,
custom
identity
string
required

User identifier to search for

unlockuuid
string
required

UUID from bulk list unlock for search authorization

request_metadata
object

Additional metadata for the request

Response

200 - application/json

Users found successfully

status
string
Example:

"ok"

rows
object[]