aam authentication server ldap

Configure an authentication-server profile for a Lightweight Directory Access Protocol (LDAP) server.

ldap Specification

Type Configuration Resource
Element Name ldap
Element URI /axapi/v3/aam/authentication/server/ldap
Element Attributes ldap_attributes
Statistics Data URI /axapi/v3/aam/authentication/server/ldap/stats
Schema ldap schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/aam/authentication/server/ldap

ldap Attributes

Get Object

GET

/axapi/v3/aam/authentication/server/ldap

ldap Attributes

Modify Object

POST

/axapi/v3/aam/authentication/server/ldap

ldap Attributes

Replace Object

PUT

/axapi/v3/aam/authentication/server/ldap

ldap Attributes

Delete Object

DELETE

/axapi/v3/aam/authentication/server/ldap

ldap Attributes

Get Stats

GET

/axapi/v3/aam/authentication/server/ldap/stats

stats data

ldap Attributes

instance-list

Description: instance-list is a JSON List . Please see below for instance-list

Type: List

Reference Object: /axapi/v3/aam/authentication/server/ldap/instance/{name}

sampling-enable

Description: sampling-enable is a JSON List . Please see below for sampling-enable

Type: List

uuid

Description: uuid of the object

Type: string

sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘admin-bind-success’: Total Admin Bind Success; ‘admin-bind-failure’: Total Admin Bind Failure; ‘bind-success’: Total User Bind Success; ‘bind-failure’: Total User Bind Failure; ‘search-success’: Total Search Success; ‘search-failure’: Total Search Failure; ‘authorize-success’: Total Authorization Success; ‘authorize-failure’: Total Authorization Failure; ‘timeout-error’: Total Timeout; ‘other-error’: Total Other Error; ‘request’: Total Request; ‘request-normal’: Total Normal Request; ‘request-dropped’: Total Dropped Request; ‘response-success’: Total Success Response; ‘response-failure’: Total Failure Response; ‘response-error’: Total Error Response; ‘response-timeout’: Total Timeout Response; ‘response-other’: Total Other Response; ‘job-start-error’: Total Job Start Error; ‘polling-control-error’: Total Polling Control Error;

Type: string

Supported Values: all, admin-bind-success, admin-bind-failure, bind-success, bind-failure, search-success, search-failure, authorize-success, authorize-failure, timeout-error, other-error, request, request-normal, request-dropped, response-success, response-failure, response-error, response-timeout, response-other, job-start-error, polling-control-error

instance-list

Specification
Type list
Block object keys

admin-dn

Description: The LDAP server’s admin DN

Type: string

Format: string-rlx

admin-secret

Description: Specify the LDAP server’s admin secret password

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

base

Description: Specify the LDAP server’s search base

Type: string

Format: string-rlx

bind-with-dn

Description: Enforce using DN for LDAP binding(All user input name will be used to create DN)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

default-domain

Description: Specify default domain for LDAP

Type: string

derive-bind-dn

Description: derive-bind-dn is a JSON Block . Please see below for l1078_derive-bind-dn

Type: Object

dn-attribute

Description: Specify Distinguished Name attribute, default is CN

Type: string

Format: string-rlx

Default: cn

encrypted

Description: Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

health-check

Description: Check server’s health status

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: health-check and health-check-disable are mutually exclusive

health-check-disable

Description: Disable configured health check configuration

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: health-check-disable and health-check are mutually exclusive

health-check-string

Description: Health monitor name

Type: string

Reference Object: /axapi/v3/health/monitor

host

Description: host is a JSON Block . Please see below for l1078_host

Type: Object

name

Description: Specify LDAP authentication server name

Type: string

Format: string-rlx

port

Description: Specify the LDAP server’s authentication port, default is 389

Type: number

Range: 1-65534

Default: 389

port-hm

Description: Check port’s health status

Type: string

Mutual Exclusion: port-hm and port-hm-disable are mutually exclusive

Reference Object: /axapi/v3/health/monitor

port-hm-disable

Description: Disable configured port health check configuration

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: port-hm-disable and port-hm are mutually exclusive

pwdmaxage

Description: Specify the LDAP server’s default password expiration time (in seconds) (The LDAP server’s default password expiration time (in seconds), default is 0 (no expiration))

Type: number

Range: 0-4294967295

Default: 0

sampling-enable

Description: sampling-enable is a JSON List . Please see below for sampling-enable

Type: List

secret-string

Description: secret password

Type: string

Format: password

timeout

Description: Specify timout for LDAP, default is 10 seconds (The timeout, default is 10 seconds)

Type: number

Range: 1-255

Default: 10

uuid

Description: uuid of the object

Type: string

instance-list.host

Specification
Type object

hostip

Description: Server’s hostname(Length 1-31) or IP address

Type: string

Format: host

Mutual Exclusion: hostip and hostipv6 are mutually exclusive

hostipv6

Description: Server’s IPV6 address

Type: string

Format: ipv6-address

Mutual Exclusion: hostipv6 and hostip are mutually exclusive

instance-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘admin-bind-success’: Admin Bind Success; ‘admin-bind-failure’: Admin Bind Failure; ‘bind-success’: User Bind Success; ‘bind-failure’: User Bind Failure; ‘search-success’: Search Success; ‘search-failure’: Search Failure; ‘authorize-success’: Authorization Success; ‘authorize-failure’: Authorization Failure; ‘timeout-error’: Timeout; ‘other-error’: Other Error; ‘request’: Request;

Type: string

Supported Values: all, admin-bind-success, admin-bind-failure, bind-success, bind-failure, search-success, search-failure, authorize-success, authorize-failure, timeout-error, other-error, request

instance-list.derive-bind-dn

Specification
Type object

username-attr

Description: Specify attribute name of username

Type: string

Format: string-rlx

stats data

Counter Size Description
bind-failure 8 Total User Bind Failure
authorize-failure 8 Total Authorization Failure
request-normal 8 Total Normal Request
admin-bind-failure 8 Total Admin Bind Failure
authorize-success 8 Total Authorization Success
response-success 8 Total Success Response
timeout-error 8 Total Timeout
response-failure 8 Total Failure Response
request 8 Total Request
response-timeout 8 Total Timeout Response
response-other 8 Total Other Response
admin-bind-success 8 Total Admin Bind Success
search-success 8 Total Search Success
polling-control-error 8 Total Polling Control Error
other-error 8 Total Other Error
request-dropped 8 Total Dropped Request
bind-success 8 Total User Bind Success
job-start-error 8 Total Job Start Error
response-error 8 Total Error Response
search-failure 8 Total Search Failure