Fortinet black logo

CLI Reference

system api-user

system api-user

Introduction.

config system api-user
    edit {name}
    # Configure API users.
        set name {string}   User name. size[35]
        set comments {string}   Comment. size[255]
        set api-key {password_string}   Admin user password. size[128]
        set accprofile {string}   Admin user access profile. size[35] - datasource(s): system.accprofile.name
        config vdom
            edit {name}
            # Virtual domains.
                set name {string}   Virtual domain name. size[64] - datasource(s): system.vdom.name
            next
        set schedule {string}   Schedule name. size[35]
        set cors-allow-origin {string}   Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible. size[269]
        set peer-auth {enable | disable}   Enable/disable peer authentication.
        set peer-group {string}   Peer group name. size[35]
        config trusthost
            edit {id}
            # Trusthost.
                set id {integer}   Table ID. range[0-4294967295]
                set type {ipv4-trusthost | ipv6-trusthost}   Trusthost type.
                        ipv4-trusthost  IPv4 trusthost.
                        ipv6-trusthost  IPv6 trusthost.
                set ipv4-trusthost {ipv4 classnet}   IPv4 trusted host address.
                set ipv6-trusthost {ipv6 prefix}   IPv6 trusted host address.
            next
    next
end

system api-user

Introduction.

config system api-user
    edit {name}
    # Configure API users.
        set name {string}   User name. size[35]
        set comments {string}   Comment. size[255]
        set api-key {password_string}   Admin user password. size[128]
        set accprofile {string}   Admin user access profile. size[35] - datasource(s): system.accprofile.name
        config vdom
            edit {name}
            # Virtual domains.
                set name {string}   Virtual domain name. size[64] - datasource(s): system.vdom.name
            next
        set schedule {string}   Schedule name. size[35]
        set cors-allow-origin {string}   Value for Access-Control-Allow-Origin on API responses. Avoid using '*' if possible. size[269]
        set peer-auth {enable | disable}   Enable/disable peer authentication.
        set peer-group {string}   Peer group name. size[35]
        config trusthost
            edit {id}
            # Trusthost.
                set id {integer}   Table ID. range[0-4294967295]
                set type {ipv4-trusthost | ipv6-trusthost}   Trusthost type.
                        ipv4-trusthost  IPv4 trusthost.
                        ipv6-trusthost  IPv6 trusthost.
                set ipv4-trusthost {ipv4 classnet}   IPv4 trusted host address.
                set ipv6-trusthost {ipv6 prefix}   IPv6 trusted host address.
            next
    next
end