Fortinet black logo

CLI Reference

config system api-user

config system api-user

Configure API users.

config system api-user
    Description: Configure API users.
    edit <name>
        set accprofile {string}
        set api-key {password-2}
        set comments {var-string}
        set cors-allow-origin {string}
        set peer-auth [enable|disable]
        set peer-group {string}
        set schedule {string}
        config trusthost
            Description: Trusthost.
            edit <id>
                set type [ipv4-trusthost|ipv6-trusthost]
                set ipv4-trusthost {ipv4-classnet}
                set ipv6-trusthost {ipv6-prefix}
            next
        end
        set vdom <name1>, <name2>, ...
    next
end

config system api-user

Parameter

Description

Type

Size

Default

accprofile

Admin user access profile.

string

Maximum length: 35

api-key

Admin user password.

password-2

Not Specified

comments

Comment.

var-string

Maximum length: 255

cors-allow-origin

Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.

string

Maximum length: 269

name

User name.

string

Maximum length: 35

peer-auth

Enable/disable peer authentication.

option

-

disable

Option

Description

enable

Enable peer.

disable

Disable peer.

peer-group

Peer group name.

string

Maximum length: 35

schedule

Schedule name.

string

Maximum length: 35

vdom <name>

Virtual domains.

Virtual domain name.

string

Maximum length: 79

config trusthost

Parameter

Description

Type

Size

Default

id

ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

type

Trusthost type.

option

-

ipv4-trusthost

Option

Description

ipv4-trusthost

IPv4 trusthost.

ipv6-trusthost

IPv6 trusthost.

ipv4-trusthost

IPv4 trusted host address.

ipv4-classnet

Not Specified

0.0.0.0 0.0.0.0

ipv6-trusthost

IPv6 trusted host address.

ipv6-prefix

Not Specified

::/0

config system api-user

Configure API users.

config system api-user
    Description: Configure API users.
    edit <name>
        set accprofile {string}
        set api-key {password-2}
        set comments {var-string}
        set cors-allow-origin {string}
        set peer-auth [enable|disable]
        set peer-group {string}
        set schedule {string}
        config trusthost
            Description: Trusthost.
            edit <id>
                set type [ipv4-trusthost|ipv6-trusthost]
                set ipv4-trusthost {ipv4-classnet}
                set ipv6-trusthost {ipv6-prefix}
            next
        end
        set vdom <name1>, <name2>, ...
    next
end

config system api-user

Parameter

Description

Type

Size

Default

accprofile

Admin user access profile.

string

Maximum length: 35

api-key

Admin user password.

password-2

Not Specified

comments

Comment.

var-string

Maximum length: 255

cors-allow-origin

Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible.

string

Maximum length: 269

name

User name.

string

Maximum length: 35

peer-auth

Enable/disable peer authentication.

option

-

disable

Option

Description

enable

Enable peer.

disable

Disable peer.

peer-group

Peer group name.

string

Maximum length: 35

schedule

Schedule name.

string

Maximum length: 35

vdom <name>

Virtual domains.

Virtual domain name.

string

Maximum length: 79

config trusthost

Parameter

Description

Type

Size

Default

id

ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

type

Trusthost type.

option

-

ipv4-trusthost

Option

Description

ipv4-trusthost

IPv4 trusthost.

ipv6-trusthost

IPv6 trusthost.

ipv4-trusthost

IPv4 trusted host address.

ipv4-classnet

Not Specified

0.0.0.0 0.0.0.0

ipv6-trusthost

IPv6 trusted host address.

ipv6-prefix

Not Specified

::/0