Check User Email for Uniqueness

Checks the Email of the user for uniqueness if provided. This is used for the purpose of creating a new user account.

Endpoint

https://<Director_IP_address>:4443/c/router

Request Example

Request Fields

Field
Type
Value(s)
Description
action string
AuthenticationManagement

The action that is invoked

method string
checkUserEmailUniqueness

The method that is invoked

data array
                                

Parameters. See the data table below

type string
rpc

Type of communication protocol

tid integer
1

Transaction ID. Used to identify the request by both the client and the server

data

Field
Type
Description
userId
string User ID to be checked for Email uniqueness. If null the Email uniqueness is checked for all users
email
string

Email of the user to be checked for uniqueness

Response Sample

Response Fields

Field
Value
Description
message
string

Message if the request failed

where
string

Reference to the method where a problem occurred

cause
string

Cause of failure

data
boolean

true if the user Email is unique, false otherwise