Sign in

v2

latestOpenAPI 3.0.12026-07-26334612609.5 KB
SDK

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

Path parameters

environmentIdstring required
Example:95b11417-f18f-457f-8804-68e361f9164f

ID of the environment

Query parameters

field'email' | 'username' | 'name-service-subdomain-handle' required
valuestring required
{
  "value": "An example name"
}

Response

successful check

fieldstring required
valuestring required
availableboolean required