API Guide

message string
Success or error message
field_name string
Field name where the error was seen
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
}]
}
3.4 POST /auth/users
Create new local user.
This API should be invoked to create a local user, and used to SFD-domain only.
REQUEST
REQUEST BODY - application/json
{
first_name* string 1 to 64 chars
last_name* string 1 to 64 chars
user_id* string 1 to 32 chars
password* string 8 to 20 chars
At least 8 characters <br> At least one lowercase character <br> At least one numeric character <br>
At least one special character <br> The password for this user cannot be more than 20 characters
long.
confirm_password* string 8 to 20 chars
Should be the same as new password provided.
user_state boolean DEFAULT:true
Tells if the user is enabled/disabled. If disabled means user can not login.
cli_access boolean
Tells if the user has CLI capabilities.
user_role enum DEFAULT:ADMIN
ALLOWED:ADMIN
contact_number string max:24 chars
}
RESPONSE
STATUS CODE - 202: New entity created successfully.
RESPONSE MODEL - application/json
{
new_object_id string
This represents the id of the new object created for the POST API call.
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
messages [{
Array of object:
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
field_name string
Field name where the error was seen
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
}]
}
STATUS CODE - 401: You are not authorized to perform this operation.
RESPONSE MODEL - application/json
{
new_object_id string
This represents the id of the new object created for the POST API call.
25 of 340