API Reference

Page tree

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
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
actionstring
AuthenticationManagement

The action that is invoked

methodstring
checkUserEmailUniqueness

The method that is invoked

dataarray

Parameters. See the data table below

typestring
rpc

Type of communication protocol

tidinteger
1

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

data

Field
Type
Description
userId
stringUser 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

{
	"action": "AuthenticationManagement",
	"method": " checkUserLoginUniqueness ",
	"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

  • No labels