Check Username for Uniqueness

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

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
string User ID to be checked for username uniqueness. If null, the username uniqueness is checked for all users
username
string Username 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 username is unique, false otherwise