Become

POST /auth/user/become

Signature authentication & Bearer authentication & Drive authentication & Drive secret key & Guest authentication & Guest secret key

application/json

Body Required

password string
country string
state string
device object
Hide device attributes Show device attributes object
- device string
- name string
- host string
- platform string
- operating_system string
- operating_system_version string
- local_host string
- ip_address string
email_address string

Responses

200 */*

OK
Hide response attributes Show response attributes object
- status string
  
  Values are 100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 EARLY_HINTS, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 425 TOO_EARLY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, or 511 NETWORK_AUTHENTICATION_REQUIRED.
- code integer(int32)
- message string
- data object
  
  Hide data attributes Show data attributes object
  
  id string(uuid)
  
  role string
  
  category string
  
  image string
  
  rating number(double)
  
  avatar string
  
  session object
  
  Hide session attributes Show session attributes object
  
  access_token string
  
  refresh_token string
  
  first_name string
  
  last_name string
  
  has_mfa boolean
  
  has_recovery_codes boolean

POST /auth/user/become

curl \
 --request POST 'https://sandbox.serchservice.com/api/v1/auth/user/become' \
 --header "X-Serch-Signed: $API_KEY" \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-Serch-Drive-Api-Key: $API_KEY" \
 --header "X-Serch-Drive-Secret-Key: $API_KEY" \
 --header "X-Serch-Guest-Api-Key: $API_KEY" \
 --header "X-Serch-Guest-Secret-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"password":"string","country":"string","state":"string","device":{"device":"string","name":"string","host":"string","platform":"string","operating_system":"string","operating_system_version":"string","local_host":"string","ip_address":"string"},"email_address":"string"}'

Request examples

{
  "password": "string",
  "country": "string",
  "state": "string",
  "device": {
    "device": "string",
    "name": "string",
    "host": "string",
    "platform": "string",
    "operating_system": "string",
    "operating_system_version": "string",
    "local_host": "string",
    "ip_address": "string"
  },
  "email_address": "string"
}

Response examples (200)

{
  "status": "100 CONTINUE",
  "code": 42,
  "message": "string",
  "data": {
    "id": "string",
    "role": "string",
    "category": "string",
    "image": "string",
    "rating": 42.0,
    "avatar": "string",
    "session": {
      "access_token": "string",
      "refresh_token": "string"
    },
    "first_name": "string",
    "last_name": "string",
    "has_mfa": true,
    "has_recovery_codes": true
  }
}