authentication

Configure authentication of admin access.

authentication Specification

Type Configuration Resource
Element Name authentication
Element URI /axapi/v3/authentication
Element Attributes authentication_attributes
Schema authentication schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/authentication

authentication Attributes

Get Object

GET

/axapi/v3/authentication

authentication Attributes

Modify Object

POST

/axapi/v3/authentication

authentication Attributes

Replace Object

PUT

/axapi/v3/authentication

authentication Attributes

Delete Object

DELETE

/axapi/v3/authentication

authentication Attributes

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

console

Specification
Type object

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

console.type-cfg

Specification
Type object

console-type

Description: Specify a type of console authentication.
  • ldap : Uses an external LDAP server for authentication.
  • local : Uses the ACOS configuration for authentication. If the administrative username and password match an entry in the configuration, the administrator is granted access.
  • radius : Uses an external RADIUS server for authentication.
  • tacplus : Uses an external TACACS+ server for authentication.

Type: string

Format: enum-list

type

Description: Enable the console login authentication type.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

mode-cfg

Specification
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
Type object

type

Description: Enable the login authentication type.

Type: string

Format: enum-list

Default: local

login-cfg

Specification
Type object

local

Description: Configure local user to enter privilege-mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

privilege-mode

Description: Places authenticated admins who log in at the Privileged EXEC level instead of at the User EXEC level.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

enable-cfg

Specification
Type object

enable-auth-type

Description: Specify the enable-password type of authentication.
  • local : Uses the ACOS configuration for authentication. If the administrative username and password match an entry in the configuration, the administrator is granted access.
  • tacplus : Uses an external TACACS+ server for authentication.

Type: string

Format: enum-list

Default: local