aam authentication portal logon

Logon page configuration

This object allows you to customize the appearance of the Logon page. You can configure the background and text associated with the logon page.

logon Specification

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

Operations Allowed:

Operation Method URI Payload

Create Object

POST

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

logon Attributes

Get Object

GET

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

logon Attributes

Modify Object

POST

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

logon Attributes

Replace Object

PUT

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

logon Attributes

Delete Object

DELETE

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

logon Attributes

logon Attributes

action-url

Description: This command allows you to modify the form action URL for the Login page.

Type: string

Format: string-rlx

background

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

Type: Object

enable-passcode

Description: Enable passcode field in default logon page

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fail-msg-cfg

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

Type: Object

passcode-cfg

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

Type: Object

passcode-var

Description: Specify passcode variable name in default logon page (Default: passcode)

Type: string

Format: string-rlx

password-cfg

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

Type: Object

password-var

Description: This command allows you to change the variable text for the title of the Password field.

Type: string

Format: string-rlx

submit-text

Description: This command allows you to modify the text on the Submit button.

Type: string

Format: string-rlx

username-cfg

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

Type: Object

username-var

Description: This command allows you to specify variable name of the user name.

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

passcode-cfg

Specification
Type object

passcode

Description: Configure passcode text in default logon page

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

passcode-color

Description: Specify font color

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

passcode-color-name

Description: ‘aqua’: aqua; ‘black’: black; ‘blue’: blue; ‘fuchsia’: fuchsia; ‘gray’: gray; ‘green’: green; ‘lime’: lime; ‘maroon’: maroon; ‘navy’: navy; ‘olive’: olive; ‘orange’: orange; ‘purple’: purple; ‘red’: red; ‘silver’: silver; ‘teal’: teal; ‘white’: white; ‘yellow’: yellow;

Type: string

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

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

passcode-color-value

Description: Specify 6-digit HEX color value

Type: string

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

passcode-face

Description: ‘Arial’: Arial; ‘Courier_New’: Courier New; ‘Georgia’: Georgia; ‘Times_New_Roman’: Times New Roman; ‘Verdana’: Verdana;

Type: string

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

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

passcode-font

Description: Sepcify font

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

passcode-font-custom

Description: Specify custom font

Type: string

Format: string-rlx

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

passcode-size

Description: Specify font size

Type: number

Range: 1-7

passcode-text

Description: Specify passcode text (Default: Passcode)

Type: string

Format: string-rlx

background

Specification
Type object

bgcolor

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

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 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 example, color #228B22.

Type: string

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

bgfile

Description: This command allows you to modify the background image file that you will use for the background of the Login page.

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 file. You can modify the following styles:
Tile, stretch and fit.

Type: string

Supported Values: tile, stretch, fit

fail-msg-cfg

Specification
Type object

authz-fail-msg

Description: Configure authorization failure message in default logon page, its text attributes follow fail-msg’s (Specify authorization failure message (Default: Authorization failed. Please contact your system administrator.))

Type: string

Format: string-rlx

fail-color

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

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fail-color-name

Description: This command allows you modify the color of the login 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 or 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 default font of the failure message text. You can use one of the following pre-defined fonts:
Arial, Courier New, Georgia, Times New Roman, or 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 use 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 the failure message text.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fail-size

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

Type: number

Range: 1-7

fail-text

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

Type: string

Format: string-rlx

password-cfg

Specification
Type object

pass-color

Description: This variable allows you to specify the new color of the Password field title text.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

pass-color-name

Description: This command allows you to modify the color of the Password field title 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 or Yellow.

Type: string

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

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

pass-color-value

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

Type: string

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

pass-face

Description: This command allows you to specify default font of the title of the Password field. You can use one of the following predefined fonts:
Arial, Courier New, Georgia, Times New Roman, or Verdana.

Type: string

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

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

pass-font

Description: This variable allows you to specify the new font of the title of the Password field.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

pass-font-custom

Description: This command allows you to specify a custom font for the title of the Password field, for example, Tahoma.

Type: string

Format: string-rlx

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

pass-size

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

Type: number

Range: 1-7

pass-text

Description: This command allows you modify the text of the Password field.

Type: string

Format: string-rlx

password

Description: This variable allows you to specify the new text for the title of the Password field.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

username-cfg

Specification
Type object

user-color

Description: This variable allows you to specify the new color of the user name field title text.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

user-color-name

Description: This command allows you to modify the color of the user name field title text.

Type: string

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

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

user-color-value

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

Type: string

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

user-face

Description: This command allows you to modify the user name field title text. You can use one of the following predefined fonts:
Arial, Courier New, Georgia, Times New Roman, or Verdana.

Type: string

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

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

user-font

Description: This variable allows you to specify a new font for the user name field title text.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

user-font-custom

Description: This command allows you to customize the font for the user name field title text, for example, Tahoma

Type: string

Format: string-rlx

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

user-size

Description: This command allows you to modify the size of the user name field title text. You can specify a font size between 1 and 7.

Type: number

Range: 1-7

user-text

Description: This command allows you to specify the new user name field title text.

Type: string

Format: string-rlx

username

Description: This variable allows you to specify the new user name field title text.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0