Get user by identifier

Request

Search for a user by identifier.

Required permissions: apps:read, [appId]:read, users:read.

Security

ClientAccessToken

Query

identifier_namestringrequired

Identifier name: one of the built-ins (email, phoneNumber, externalUserId, username, idpIdentifier) or a tenant-defined custom identifier

identifier_valuestringrequired

Identifier value

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/identifier?identifier_name=string&identifier_value=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

resultobjectrequired

Response

{
  "result": {
    "email": { … },
    "secondary_emails": [ … ],
    "phone_number": { … },
    "secondary_phone_numbers": [ … ],
    "username": "string",
    "user_id": "string",
    "birthday": "2019-08-24T14:15:22Z",
    "address": { … },
    "name": { … },
    "status": "Active",
    "status_changed_at": "2019-08-24T14:15:22Z",
    "created_at": 0,
    "updated_at": 0,
    "identity_providers": [ … ],
    "identities": [ … ],
    "last_auth": "2019-08-24T14:15:22Z",
    "external_account_id": "string",
    "app_name": "string",
    "custom_app_data": {},
    "groupIds": [ … ],
    "picture": "string",
    "language": "string",
    "custom_data": {},
    "external_user_id": "string",
    "password_information": { … },
    "custom_user_fields": {}
  }
}