PortalConfiguration

PortalConfiguration
PortalConfiguration
JSON Example
{
    "allow_basic_authentication": false,
    "api_force_timeout": 0,
    "disable_remote_cli_shell": false,
    "disable_swagger": false,
    "enable_clickjacking_protection": false,
    "enable_http": false,
    "enable_https": false,
    "enable_rate_limiter": false,
    "http_port": 0,
    "https_port": 0,
    "legacy_ssl_support": false,
    "minimum_password_length": 0,
    "password_strength_check": false,
    "pkiprofile_ref": "string",
    "redirect_to_https": false,
    "sslkeyandcertificate_refs": [
        "string"
    ],
    "sslprofile_ref": "string",
    "use_uuid_from_input": false
}
boolean
allow_basic_authentication
Optional

Enable/Disable HTTP basic authentication. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
api_force_timeout
Optional
Constraints: default: 24

Force API session timeout after the specified time (in hours). Allowed values are 1-24. Field introduced in 18.2.3. Unit is HOURS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
disable_remote_cli_shell
Optional

Disable Remote CLI Shell Client access. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
disable_swagger
Optional

Disable Swagger access. Field introduced in 18.2.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
enable_clickjacking_protection
Optional
Constraints: default: true

Enable/Disable Clickjacking protection. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
enable_http
Optional
Constraints: default: true

Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
enable_https
Optional
Constraints: default: true

Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
enable_rate_limiter
Optional

Feature flag for enabling rate limiter(false by default). Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

integer As uint32 As uint32
http_port
Optional

HTTP port. Allowed values are 1-65535. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
https_port
Optional

HTTPS port. Allowed values are 1-65535. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
legacy_ssl_support
Optional

Allow Incoming Connections from Clients Using TLS 1.0/1.1 to Controller. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

integer As uint32 As uint32
minimum_password_length
Optional
Constraints: default: 8

Minimum password length for user accounts. Allowed values are 6-32. Field introduced in 20.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

boolean
password_strength_check
Optional

Strict checking of password strength for user accounts. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
pkiprofile_ref
Optional

Reference to PKIProfile Config used for CRL validation. It is a reference to an object of type PKIProfile. Field introduced in 30.1.2. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

boolean
redirect_to_https
Optional
Constraints: default: true

Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of string
sslkeyandcertificate_refs
Optional

Certificates for system portal. Maximum 2 allowed. Leave list empty to use system default certs. It is a reference to an object of type SSLKeyAndCertificate. Maximum of 2 items allowed. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
sslprofile_ref
Optional

It is a reference to an object of type SSLProfile. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
use_uuid_from_input
Optional

Use UUID in POST object data as UUID of the new object, instead of a generated UUID. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.