Fortinet white logo
Fortinet white logo

CLI Reference

config user oidc

config user oidc

OpenID Connect server entry configuration.

config user oidc
    Description: OpenID Connect server entry configuration.
    edit <name>
        set type [discovery|manual]
        set client-id {string}
        set client-secret {string}
        set discovery-url {string}
        set authorization-url {string}
        set token-url {string}
        set jwks-uri {string}
        set domain-hint {string}
        set issuer {string}
        set verify-issuer [enable|disable]
        set user-attr-name [email|sub|...]
        set user-regex {string}
        set ldap-server <name1>, <name2>, ...
        set clock-tolerance {integer}
    next
end

config user oidc

Parameter

Description

Type

Size

Default

name

OpenID Connect server entry name.

string

Maximum length: 35

type

Type of OpenID Connect config.

option

-

discovery

Option

Description

discovery

Use discovery URL to get configuration.

manual

Use manual configuration.

client-id

OpenID Connect server client ID.

string

Maximum length: 127

client-secret

OpenID Connect server client secret.

string

Maximum length: 127

discovery-url

OpenID Connect server discovery URL.

string

Maximum length: 255

authorization-url

OpenID Connect server authorization URL.

string

Maximum length: 255

token-url

OpenID Connect server token URL.

string

Maximum length: 255

jwks-uri

URL of the OP's JWK Set document.

string

Maximum length: 255

domain-hint

Domain Hint.

string

Maximum length: 255

issuer

OpenID Connect server issuer.

string

Maximum length: 255

verify-issuer

Verify issuer in ID token (default = enable).

option

-

enable

Option

Description

enable

Enable verification of issuer in ID token (default).

disable

Disable verification of issuer in ID token.

user-attr-name

Which field in ID token is username

option

-

email

Option

Description

email

Use email in ID token as username.

sub

Use sub in ID token as username.

preferred_username

Use preferred_username in ID token as username.

user-regex

username must match this regex (case insensitive).

string

Maximum length: 255

ldap-server <name>

LDAP server name(s).

LDAP server name.

string

Maximum length: 79

clock-tolerance

Clock skew tolerance in seconds (0 - 300, default = 15, 0 = no tolerance).

integer

Minimum value: 0 Maximum value: 300

15

config user oidc

config user oidc

OpenID Connect server entry configuration.

config user oidc
    Description: OpenID Connect server entry configuration.
    edit <name>
        set type [discovery|manual]
        set client-id {string}
        set client-secret {string}
        set discovery-url {string}
        set authorization-url {string}
        set token-url {string}
        set jwks-uri {string}
        set domain-hint {string}
        set issuer {string}
        set verify-issuer [enable|disable]
        set user-attr-name [email|sub|...]
        set user-regex {string}
        set ldap-server <name1>, <name2>, ...
        set clock-tolerance {integer}
    next
end

config user oidc

Parameter

Description

Type

Size

Default

name

OpenID Connect server entry name.

string

Maximum length: 35

type

Type of OpenID Connect config.

option

-

discovery

Option

Description

discovery

Use discovery URL to get configuration.

manual

Use manual configuration.

client-id

OpenID Connect server client ID.

string

Maximum length: 127

client-secret

OpenID Connect server client secret.

string

Maximum length: 127

discovery-url

OpenID Connect server discovery URL.

string

Maximum length: 255

authorization-url

OpenID Connect server authorization URL.

string

Maximum length: 255

token-url

OpenID Connect server token URL.

string

Maximum length: 255

jwks-uri

URL of the OP's JWK Set document.

string

Maximum length: 255

domain-hint

Domain Hint.

string

Maximum length: 255

issuer

OpenID Connect server issuer.

string

Maximum length: 255

verify-issuer

Verify issuer in ID token (default = enable).

option

-

enable

Option

Description

enable

Enable verification of issuer in ID token (default).

disable

Disable verification of issuer in ID token.

user-attr-name

Which field in ID token is username

option

-

email

Option

Description

email

Use email in ID token as username.

sub

Use sub in ID token as username.

preferred_username

Use preferred_username in ID token as username.

user-regex

username must match this regex (case insensitive).

string

Maximum length: 255

ldap-server <name>

LDAP server name(s).

LDAP server name.

string

Maximum length: 79

clock-tolerance

Clock skew tolerance in seconds (0 - 300, default = 15, 0 = no tolerance).

integer

Minimum value: 0 Maximum value: 300

15