Fortinet black logo

CLI Reference

waf api-users

Use this command to define API users to restrict access to APIs based on API keys.

Syntax

config waf api-users

edit <api-user_name>

set email <email_str>

set comments <comments_str>

set uuid <uuid_str>

set api-key <api-key_str>

set create-time <create-time_str>

config ip-access-list

edit <ip-access-list_id>

set ip <ip_str>

next

end

config http-referer-list

edit <http-referer-list_id>

set http-referer <http-referer_str>

next

end

next

end

Variable Description Default

<api-user_name>

Enter a name that identifies the user.

No default.

email <email_str>

Type the email address of the user that is used for contact

purpose.

No default.

comments <comments_str>

Optionally, enter a description or comments for the user.

No default.

uuid <uuid_str>

Enter a unique identifier for the requesting user.

No default.

api-key <api-key_str>

Specify an API key for the API user; the minimum length is 40 characters.

No default.

create-time <create-time_str>

Specify the API user creation time.

No default.

<ip-access-list_id>

The index number of the IP entry.

No default.

<ip_str>

Specify the IP addresses from which the API key can only be used.

No default.

<http-referer-list_id>

The index number of the referer HTTP header entry.

No default.

http-referer <http-referer_str>

Specify the referer HTTP header in which the specified URLs are present.

No default.

Related topics

Use this command to define API users to restrict access to APIs based on API keys.

Syntax

config waf api-users

edit <api-user_name>

set email <email_str>

set comments <comments_str>

set uuid <uuid_str>

set api-key <api-key_str>

set create-time <create-time_str>

config ip-access-list

edit <ip-access-list_id>

set ip <ip_str>

next

end

config http-referer-list

edit <http-referer-list_id>

set http-referer <http-referer_str>

next

end

next

end

Variable Description Default

<api-user_name>

Enter a name that identifies the user.

No default.

email <email_str>

Type the email address of the user that is used for contact

purpose.

No default.

comments <comments_str>

Optionally, enter a description or comments for the user.

No default.

uuid <uuid_str>

Enter a unique identifier for the requesting user.

No default.

api-key <api-key_str>

Specify an API key for the API user; the minimum length is 40 characters.

No default.

create-time <create-time_str>

Specify the API user creation time.

No default.

<ip-access-list_id>

The index number of the IP entry.

No default.

<ip_str>

Specify the IP addresses from which the API key can only be used.

No default.

<http-referer-list_id>

The index number of the referer HTTP header entry.

No default.

http-referer <http-referer_str>

Specify the referer HTTP header in which the specified URLs are present.

No default.

Related topics