Fortinet black logo

CLI Reference

user oauth-user request

user oauth-user request

FortiWeb supports front-end authentication with third party authentication servers such as Google and Facebook.

Use this command to create OAuth requests. For more information about OAuth requests, refer to "OAuth authorization & OIDC authentication" in FortiWeb Administration Guide.

To use this command, your administrator account’s access control profile must have either w or rw permission to the authusergrp area. For details, see Permissions.

Syntax

config user oauth-user request

edit <oauth_request_name>

set type {authz | token | refresh | validate | userinfo}

set endpoint <string>

set method {get | post}

set ctype {urlencoded | json}

set user-key <string>

set tls-check {enable | disable}

set tls-ca <ca_name>

config custom-headers

edit <index>

set <custom-parameters_name>

set <custom-parameters_value>

next

end

config custom-parameters

edit <index>

set <custom-headers_name>

set <custom-headers_value>

next

end

next

end

Variable Description Default

<oauth_request_name>

Enter a name for the request. No default

type {authz | token | refresh | validate | userinfo}

Select the OAuth request types.

authz

endpoint <string>

Enter the OAuth request URL. No default

method {get | post}

Select the request method. post

ctype {urlencoded | json}

Select the request content type. urlencoded

user-key <string>

Indicate username keyword in response. No default

tls-check {enable | disable}

Enable to do strict TLS verification even with a custom CA certificate to check the TLS traffic between FortiWeb and the third party OAuth authorization servers.

disable

tls-ca <ca_name>

Select the certificate to check the TLS traffic. It's uploaded in System > Admin > Certificates.

No default

<custom-headers_name>

Enter the name of the header to insert in the request.

No default

<custom-headers_value>

Enter the value of the header.

No default

<custom-parameters_name>

Enter the name of the parameter to insert into the request.

No default

<custom-parameters_value>

Enter the value of the parameter.

No default

Related topics

user oauth-user request

FortiWeb supports front-end authentication with third party authentication servers such as Google and Facebook.

Use this command to create OAuth requests. For more information about OAuth requests, refer to "OAuth authorization & OIDC authentication" in FortiWeb Administration Guide.

To use this command, your administrator account’s access control profile must have either w or rw permission to the authusergrp area. For details, see Permissions.

Syntax

config user oauth-user request

edit <oauth_request_name>

set type {authz | token | refresh | validate | userinfo}

set endpoint <string>

set method {get | post}

set ctype {urlencoded | json}

set user-key <string>

set tls-check {enable | disable}

set tls-ca <ca_name>

config custom-headers

edit <index>

set <custom-parameters_name>

set <custom-parameters_value>

next

end

config custom-parameters

edit <index>

set <custom-headers_name>

set <custom-headers_value>

next

end

next

end

Variable Description Default

<oauth_request_name>

Enter a name for the request. No default

type {authz | token | refresh | validate | userinfo}

Select the OAuth request types.

authz

endpoint <string>

Enter the OAuth request URL. No default

method {get | post}

Select the request method. post

ctype {urlencoded | json}

Select the request content type. urlencoded

user-key <string>

Indicate username keyword in response. No default

tls-check {enable | disable}

Enable to do strict TLS verification even with a custom CA certificate to check the TLS traffic between FortiWeb and the third party OAuth authorization servers.

disable

tls-ca <ca_name>

Select the certificate to check the TLS traffic. It's uploaded in System > Admin > Certificates.

No default

<custom-headers_name>

Enter the name of the header to insert in the request.

No default

<custom-headers_value>

Enter the value of the header.

No default

<custom-parameters_name>

Enter the name of the parameter to insert into the request.

No default

<custom-parameters_value>

Enter the value of the parameter.

No default

Related topics