authentication¶

Configure authentication feature

authentication Specification¶

Parameter Value

Type Configuration Resource

Element Name authentication

Element URI /axapi/v3/authentication

Element Attributes authentication_attributes

Partition Visibility shared

Schema authentication schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/authentication	authentication attributes
POST /axapi/v3/authentication Payload: { "authentication": { "console": { "type-cfg": { "console-type": "ldap", "type": 1 } }, "type-cfg": { "type": "ldap" } } }
Get Object	GET	/axapi/v3/authentication	authentication attributes
GET /axapi/v3/authentication Reponse: { "authentication": { "type-cfg": { "type": "ldap" }, "enable-cfg": { "enable-auth-type": "local" }, "login-cfg": { "privilege-mode": 0 }, "mode-cfg": { "mode": "single" }, "multiple-auth-reject": 0, "uuid": "db1b7aa4-6612-11d9-9a27-692335d4f00d", "console": { "type-cfg": { "type": 1, "console-type": "ldap" }, "uuid": "5fb3b580-4f5e-11ee-bde4-3768133b9b1a", "a10-url": "/axapi/v3/authentication/console" }, "a10-url": "/axapi/v3/authentication" } }
Modify Object	POST	/axapi/v3/authentication	authentication attributes
Replace Object	PUT	/axapi/v3/authentication	authentication attributes
Delete Object	DELETE	/axapi/v3/authentication	authentication attributes
DELETE /axapi/v3/authentication Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

authentication attributes¶

console

Description: console is a JSON Block. Please see below for console

Type: Object

Reference Object: /axapi/v3/authentication/console

enable-cfg

Description: enable-cfg is a JSON Block. Please see below for enable-cfg

Type: Object

login-cfg

Description: login-cfg is a JSON Block. Please see below for login-cfg

Type: Object

mode-cfg

Description: mode-cfg is a JSON Block. Please see below for mode-cfg

Type: Object

multiple-auth-reject

Description Multiple same user login reject

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

type-cfg

Description: type-cfg is a JSON Block. Please see below for type-cfg

Type: Object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

console¶

Specification Value

Type object

type-cfg

Description: type-cfg is a JSON Block. Please see below for console_type-cfg

Type: Object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

console_type-cfg¶

Specification Value

Type object

console-type

Description

Type: string

Format: enum-list

type

Description The login authentication type

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

mode-cfg¶

Specification Value

Type object

mode

Description ‘multiple’: Multiple authentication mode. If an authentication method rejected, try next one; ‘single’: Single authentication mode. If an authentication method rejected, don’t try next one;

Type: string

Supported Values: multiple, single

Default: single

type-cfg¶

Specification Value

Type object

type

Description The login authentication type

Type: string

Format: enum-list

Default: local

login-cfg¶

Specification Value

Type object

local

Description Configure local user to enter privilege-mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

privilege-mode

Description Configure to enter privilege-mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

enable-cfg¶

Specification Value

Type object

enable-auth-type

Description The enable-password authentication type

Type: string

Format: enum-list

Default: local