aam authentication portal change-password

Change password page configuration

This object allows you to configure the appearance of the Change Password page.

change-password Specification

Type Configuration Resource
Element Name change-password
Element URI /axapi/v3/aam/authentication/portal/{name}/change-password
Element Attributes change-password_attributes
Schema change-password schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/aam/authentication/portal/{name}/change-password

change-password Attributes

Get Object

GET

/axapi/v3/aam/authentication/portal/{name}/change-password

change-password Attributes

Modify Object

POST

/axapi/v3/aam/authentication/portal/{name}/change-password

change-password Attributes

Replace Object

PUT

/axapi/v3/aam/authentication/portal/{name}/change-password

change-password Attributes

Delete Object

DELETE

/axapi/v3/aam/authentication/portal/{name}/change-password

change-password Attributes

change-password Attributes

action-url

Description: This command allows you to change how the form action URL for the Change Password page is displayed.

Type: string

Format: string-rlx

background

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

Type: Object

cfm-pwd-cfg

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

Type: Object

confirm-password-var

Description: This command allows you to change how the variable name of the field in which users re-enter their new password for confirmation is displayed.

Type: string

Format: string-rlx

new-password-var

Description: This command allows you to modify the variable name of the of the new password on the Change Password page.

Type: string

Format: string-rlx

new-pwd-cfg

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

Type: Object

old-password-var

Description: This command allows you to modify the text of the current password variable name.

Type: string

Format: string-rlx

old-pwd-cfg

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

Type: Object

reset-text

Description: This command allows you to change the text on the button that users click to reset their passwords on the Change Password page.

Type: string

Format: string-rlx

submit-text

Description: This command allows you to modify the text on the button that the user clicks to confirm a new password on the Change Password page.

Type: string

Format: string-rlx

title-cfg

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

Type: Object

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 change the variable name of the default Change Password page.

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

new-pwd-cfg

Specification
Type object

new-color

Description: This variable allows you to specify a new font color of the text of the field in which users enter their new password.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

new-color-name

Description: This command allows you to modify the color of the text of the field in which users enter their new password. You can use one of the predefined 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: new-color-name and new-color-value are mutually exclusive

new-color-value

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

Type: string

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

new-face

Description: This command allows you to modify the font of the user name that the user will enter. You can specify 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: new-face and new-font-custom are mutually exclusive

new-font

Description: This variable allows you to specify a new font for the text of the field in which users enter their new password.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

new-font-custom

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

Type: string

Format: string-rlx

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

new-password

Description: This variable allows you to specify the new text of the field in which users enter their new password.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

new-size

Description: This variable allows you to specify the new size of the text of the field in which users enter their new password. you can specify a font size between 1 and 7.

Type: number

Range: 1-7

new-text

Description: This command allows you to modify the text of the field in which users enter their new password.

Type: string

Format: string-rlx

title-cfg

Specification
Type object

title

Description: This variable allows you to specify the updated text for the title of the page.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

title-color

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

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

title-color-name

Description: This command allows you to modify the title color.

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 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: title-face and title-font-custom are mutually exclusive

title-font

Description: This variable allows you to specify the new text for the title font.

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 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 to modify the title text.

Type: string

Format: string-rlx

old-pwd-cfg

Specification
Type object

old-color

Description: This variable allows you to specify the new color of the title text of the field in which users will enter their current password.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

old-color-name

Description: This command allows you to modify the color of the title text of the field in which users will enter their current password. You can specify one of the following predefined 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: old-color-name and old-color-value are mutually exclusive

old-color-value

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

Type: string

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

old-face

Description: This command allows you to modify the font of the title of the in which users will enter their current password.

Type: string

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

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

old-font

Description: This variable allows you specify a new font of the title text of the field in which users will enter their current password.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

old-font-custom

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

Type: string

Format: string-rlx

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

old-password

Description: This variable allows you to modify the title text of the field in which users will enter their current password.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

old-size

Description: This variable allows you to specify the new size of the title text of the field in which users will enter their current password.

Type: number

Range: 1-7

old-text

Description: This command allows you to modify the title text of the field in which users will enter their current password.

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 teh color of the background image. You can modify 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 modify the background image file for the Change Password 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. You can modify the following styles:
Tile, stretch and fit.

Type: string

Supported Values: tile, stretch, fit

cfm-pwd-cfg

Specification
Type object

cfm-color

Description: This variable allows you to modify the color of the title text of the field in which users re-enter a new password for confirmation.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cfm-color-name

Description: This command allows you to modify the color of the title text of the field in which users re-enter a new password for confirmation.

Type: string

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

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

cfm-color-value

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

Type: string

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

cfm-face

Description: This command allows you to modify the font of the title text of the field in which users re-enter a new password for confirmation. You can use on of the following fonts:
Arial, Courier New, Georgia, Times New Roman, and Verdana.

Type: string

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

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

cfm-font

Description: This variable allows you to specify a new font for the title text of the field in which users re-enter a new password for confirmation.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cfm-font-custom

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

Type: string

Format: string-rlx

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

cfm-size

Description: This variable allows you to modify the size of title text of the field in which users re-enter a new password for confirmation. You can specify a font size between 1 and 7

Type: number

Range: 1-7

cfm-text

Description: This command allows you to modify the appearance of the Confirm Password field.

Type: string

Format: string-rlx

confirm-password

Description: This variable allows you to specify the new title text of the field in which users re-enter a new password for confirmation.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

username-cfg

Specification
Type object

user-color

Description: This variable allows you to specify a new font color for the user name field 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 text. You can specify one of the following predefined 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: 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 font of the user name field text. You can specify 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 text.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

user-font-custom

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

Type: string

Format: string-rlx

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

user-size

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

Type: number

Range: 1-7

user-text

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

Type: string

Format: string-rlx

username

Description: This variable allows you to specify the new user name text in the default Change Password page.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0