Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact UnboundID support in order to understand the potential impact of that change.
The Form Login HTTP Authentication Scheme may be used to provide a form login configuration for authentication with a username and password
↓Parent Component
↓Properties
↓dsconfig Usage
The Form Login HTTP Authentication Scheme component inherits from the HTTP Authentication Scheme
The properties supported by this managed object are as follows:
Basic Properties: | Advanced Properties: |
---|---|
↓ description | None |
↓ enabled | |
↓ login-processing-url | |
↓ login-failure-url | |
↓ default-login-success-url | |
↓ always-use-default-login-success-url | |
↓ login-page-url |
Description | A description for this HTTP Authentication Scheme |
Default Value | None |
Allowed Values | A string |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
Description | Indicates whether the authentication scheme is enabled. If a scheme is not enabled, then its authentication requests using this scheme will not be processed. |
Default Value | None |
Allowed Values | true false |
Multi-Valued | No |
Required | Yes |
Admin Action Required | None. Modification requires no further action |
Description | The URL that that will process the login form. |
Default Value | /login.do |
Allowed Values | The value must start with a forward slash and must represent a valid HTTP context path. |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
Description | The URL for the login failure page. |
Default Value | None |
Allowed Values | A string |
Multi-Valued | No |
Required | Yes |
Admin Action Required | None. Modification requires no further action |
Description | The URL that will be redirected to after successful authentication, if the user's previous action could not be resumed. This generally happens if the user visits a login page without having first requested a secured operation that triggers authentication. |
Default Value | / |
Allowed Values | A string |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
always-use-default-login-success-url
Description | Whether the user should always be redirected to the default-login-success-url after login. |
Default Value | false |
Allowed Values | true false |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
Description | The URL for the login page. |
Default Value | None |
Allowed Values | A string |
Multi-Valued | No |
Required | Yes |
Admin Action Required | None. Modification requires no further action |
To list the configured HTTP Authentication Schemes:
dsconfig list-http-authentication-schemes [--property {propertyName}] ...
To view the configuration for an existing HTTP Authentication Scheme:
dsconfig get-http-authentication-scheme-prop --scheme-name {name} [--tab-delimited] [--script-friendly] [--property {propertyName}] ...
To update the configuration for an existing HTTP Authentication Scheme:
dsconfig set-http-authentication-scheme-prop --scheme-name {name} (--set|--add|--remove) {propertyName}:{propertyValue} [(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Form Login HTTP Authentication Scheme:
dsconfig create-http-authentication-scheme --scheme-name {name} --type form-login --set enabled:{propertyValue} --set login-failure-url:{propertyValue} --set login-page-url:{propertyValue} [--set {propertyName}:{propertyValue}] ...
To delete an existing HTTP Authentication Scheme:
dsconfig delete-http-authentication-scheme --scheme-name {name}