Check User Email for Uniqueness

Product version: 10.11

Last modified: 31 July 2024

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

curl

Copy

curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header "content-type: application/json" \
    --cookie cookies.txt \
    --data '{
            "action": "AuthenticationManagement",
            "method": "checkUserEmailUniqueness",
            "data": [null,"admin1@nakivo.com"],
            "type": "rpc",
            "tid": 1}'

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	[null, "admin1@nakivo.com"]	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	long	Optional. ID of an existing user to exclude from the check, for example, the user whose account is being edited. If `null`, the email is checked against all users
`email`	string	Email of the user to be checked for uniqueness

Response Sample

curl

Copy

{
    "action": "AuthenticationManagement",
    "method": "checkUserEmailUniqueness",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": true
}

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