API Guide

RESPONSE
STATUS CODE - 200: Get all users details congured with NFC
RESPONSE MODEL - application/json
{
data [{
Array of object:
first_name string
last_name string
user_id string
overall_state enum DEFAULT:ACTIVE
ALLOWED:ACTIVE, INACTIVE
Tells if the user overall user status is ACTIVE or INACTIVE.
cli_state enum DEFAULT:ACTIVE
ALLOWED:ACTIVE, ENABLE_IN_PROGRESS, DISABLE_IN_PROGRESS,
INACTIVE, SSH_CREATION_FAILED
Tells if the user CLI access is ACTIVE or INACTIVE or change is IN_PROGRESS.
SSH_CREATION_FAILED happens when SSH access creation fails, during which deletion and
recreation of user is recommended.
user_role enum DEFAULT:ADMIN
ALLOWED:ADMIN
ad_user boolean
Tells if it is AD user.
contact_number string
updated_by string
last_updated integer
}]
}
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.
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 - default: success or error response
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.
24 of 340