API Guide

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.
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.15 PUT /auth/servers/ldap
Congure by giving LDAP server url and credentials to verify authentication with the congured server url.
This API should be invoked to congure LDAP server URL
REQUEST
REQUEST BODY - application/json
{
url* string min:1 chars
LDAP server url
username* string min:1 chars
LDAP username
password* string min:1 chars
LDAP password
attributes* string
LDAP attributes
description string max:254 chars
LDAP cong description
}
RESPONSE
STATUS CODE - 201: New entity created successfully.
RESPONSE MODEL - application/json
41 of 340