aam authentication portal logon-fail

Logon fail page configuration

This object allows you to customize the appearance of your Logon Fail page. You are able to configure how the, background, welcome message, login failure message and note are displayed.

logon-fail Specification

Type Configuration Resource
Element Name logon-fail
Element URI /axapi/v3/aam/authentication/portal/{name}/logon-fail
Element Attributes logon-fail_attributes
Schema logon-fail schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/aam/authentication/portal/{name}/logon-fail

logon-fail Attributes

Get Object

GET

/axapi/v3/aam/authentication/portal/{name}/logon-fail

logon-fail Attributes

Modify Object

POST

/axapi/v3/aam/authentication/portal/{name}/logon-fail

logon-fail Attributes

Replace Object

PUT

/axapi/v3/aam/authentication/portal/{name}/logon-fail

logon-fail Attributes

Delete Object

DELETE

/axapi/v3/aam/authentication/portal/{name}/logon-fail

logon-fail Attributes

logon-fail Attributes

background

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

Type: Object

fail-msg-cfg

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

Type: Object

title-cfg

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

Type: Object

uuid

Description: uuid of the object

Type: string

fail-msg-cfg

Specification
Type object

fail-color

Description: This variable allows you to specify the new color of the failure login message text.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fail-color-name

Description: This command allows you to modify the color of the logon failure message text. You can specify one of the following colors:
Aqua, Black, Blue, Fuchsia, Gray, Green Lime, Maroon, Navy Olive, Orange, Purple, Red, Silver, Teal, White and Yellow.

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: fail-color-name and fail-color-value are mutually exclusive

fail-color-value

Description: This command allows you to specify a 6-digit HEX color value, for example, color #228B22.

Type: string

Mutual Exclusion: fail-color-value and fail-color-name are mutually exclusive

fail-face

Description: This command allows you to modify the font of the failure message text. You can use one of the following predefined fonts:
Arial, Courier New, Georgia, Times New Roman, and Verdana.

Type: string

Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana

Mutual Exclusion: fail-face and fail-font-custom are mutually exclusive

fail-font

Description: This variable allows you to specify the font of the new login failure message.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fail-font-custom

Description: This command allows you to specify a custom font for example, Tahoma.

Type: string

Format: string-rlx

Mutual Exclusion: fail-font-custom and fail-face are mutually exclusive

fail-msg

Description: This variable allows you to specify the updated logon failure message on the default Logon Fail page.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fail-size

Description: This variable allows you to specify the new font size. You can specify a font size between 1 and 7.

Type: number

Range: 1-7

fail-text

Description: This command allows you to modify the failure message.

Type: string

Format: string-rlx

title-cfg

Specification
Type object

title

Description: This variable allows you to specify the updated title of the Logon Fail page.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

title-color

Description: This variable allows you to specify a new color of the title of the Logon Fail page.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

title-color-name

Description: This command allows you to modify the color of the title of the Logon Fail page. You can specify one of the following colors:
Aqua, Black, Blue, Fuchsia, Gray, Green Lime, Maroon, Navy Olive, Orange, Purple, Red, Silver, Teal, White and Yellow.

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: title-color-name and title-color-value are mutually exclusive

title-color-value

Description: This command allows you to specify a 6-digit HEX color value for the login failure message text, for example color #228B22.

Type: string

Mutual Exclusion: title-color-value and title-color-name are mutually exclusive

title-face

Description: This command allows you to modify the font of the title of the Logon Fail page. You can use one of the predefined fonts:
Arial, Courier New, Georgia, Times New Roman, and Verdana.

Type: string

Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana

Mutual Exclusion: title-face and title-font-custom are mutually exclusive

title-font

Description: This variable allows you to specify the font of the new title of the Logon Fail page.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

title-font-custom

Description: This command allows you to specify a custom font for example, Tahoma.

Type: string

Format: string-rlx

Mutual Exclusion: title-font-custom and title-face are mutually exclusive

title-size

Description: This variable allows you to specify the new font size. You can specify a font size between 1 and 7

Type: number

Range: 1-7

title-text

Description: This command allows you modify the title of the Logon Fail page.

Type: string

Format: string-rlx

background

Specification
Type object

bgcolor

Description: This variable allows you to specify the new color of the background image.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: bgcolor and bgfile are mutually exclusive

bgcolor-name

Description: This command allows you to modify the color of the background image. You can specify one of the following colors:
Aqua, Black, Blue, Fuchsia, Gray, Green, Lime, Maroon, Navy, Olive, Orange, Purple, Red, Silver, Teal, White and Yellow.

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: bgcolor-name and bgcolor-value are mutually exclusive

bgcolor-value

Description: This command allows you to specify a 6-digit HEX color value for a custom color, for example, color #228B22.

Type: string

Mutual Exclusion: bgcolor-value and bgcolor-name are mutually exclusive

bgfile

Description: This command allows you to access the directory where the login page files are located.

Type: string

Format: string-rlx

Mutual Exclusion: bgfile and bgcolor are mutually exclusive

bgstyle

Description: This command allows you to modify the style of the background image. You can modify the following styles:
Tile, stretch and fit.

Type: string

Supported Values: tile, stretch, fit