Check user field uniqueness

Check if the unique field value is already taken. For example, an enabled unique username or unique email. This also works with enabled unique custom fields.

GET /sdk/{environmentId}/users/check

Try it

Check user field uniqueness

cURL

curl --request GET \
  --url https://app.dynamicauth.com/api/v0/sdk/{environmentId}/users/check \
  --header 'Authorization: Bearer <token>'

200

{
  "field": "<string>",
  "value": "<string>",
  "available": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId · string · required

ID of the environment

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Query Parameters

filter · object

Show child attributes

filter. field · enum<string> · required

Available options: email, username, name-service-subdomain-handle

filter. value · string · required

Maximum string length: 255

Example:

"An example name"

Response

200

application/json

successful check

field · string · required

value · string · required

available · boolean · required