Page tree

Checks the username for uniqueness. This is used for the purpose of creating a new user.

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": "checkUserLoginUniqueness",
		"data": [null,"admin1"],
		"type": "rpc",
		"tid": 1}"

Request Fields

Field
Type
Value(s)
Description
action
string
AuthenticationManagement

The action that is invoked

method
string
checkUserLoginUniqueness

The method that is invoked

data
array

The method that is invoked 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
stringUser ID to be checked for username uniqueness. If null, the username uniqueness is checked for all users
username
stringUsername 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
messagestringMessage if the request failed
wherestringReference to the method where a problem occurred
causestringCause of failure
databoolean

true if the username is unique, false otherwise

  • No labels