config user saml

SAML server entry configuration.

config user saml
    Description: SAML server entry configuration.
    edit <name>
        set adfs-claim [enable|disable]
        set cert {string}
        set clock-tolerance {integer}
        set digest-method [sha1|sha256]
        set entity-id {string}
        set fabric-force-sync [enable|disable]
        set fabric-object [enable|disable]
        set fabric-object-source [member|local|...]
        set group-claim-type [email|given-name|...]
        set group-name {string}
        set idp-cert {string}
        set idp-entity-id {string}
        set idp-single-logout-url {string}
        set idp-single-sign-on-url {string}
        set limit-relaystate [enable|disable]
        set realm {string}
        set reauth [enable|disable]
        set require-signed-resp-and-asrt [enable|disable]
        set scim-client {string}
        set scim-group-attr-type [display-name|external-id]
        set scim-user-attr-type [user-name|display-name|...]
        set service-provider-address {string}
        set single-logout-url {string}
        set single-sign-on-url {string}
        set type [custom|fortiidentity-cloud]
        set user-claim-type [email|given-name|...]
        set user-name {string}
        set user-source {string}
        set uuid {uuid}
    next
end

config user saml

Parameter

Description

Type

Size

Default

adfs-claim

Enable/disable ADFS Claim for user/group attribute in assertion statement (default = disable).

option

disable

Option	Description
enable	Enable ADFS Claim for user/group attribute in assertion statement.
disable	Disable ADFS Claim for user/group attribute in assertion statement.

cert

Certificate to sign SAML messages.

string

Maximum length: 35

clock-tolerance

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

integer

Minimum value: 0 Maximum value: 300

digest-method

Digest method algorithm.

option

sha256 **

Option	Description
sha1	Digest Method Algorithm is SHA1.
sha256	Digest Method Algorithm is SHA256.

entity-id

SP entity ID.

string

Maximum length: 255

fabric-force-sync *

Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped.

option

disable

Option	Description
enable	Enable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices.
disable	Disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices.

fabric-object *

Security Fabric global object setting.

option

disable

Option	Description
enable	Object is set as a security fabric-wide global object.
disable	Object is local to this security fabric member.

fabric-object-source *

Source of truth for fabric object.

option

root

Option	Description
member	Source of truth for this object is a non-root member of fabric.
local	Source of truth for this object is this security fabric member.
root	Source of truth for this object is the root of the fabric.

group-claim-type

Group claim in assertion statement.

option

group

Option	Description
email	E-mail address of the user.
given-name	Given name of the user.
name	Unique name of the user.
upn	User principal name (UPN) of the user.
common-name	Common name of the user.
email-adfs-1x	E-mail address of the user when interoperating with AD FS 1.1 or ADFS 1.0.
group	Group that the user is a member of.
upn-adfs-1x	User principal name (UPN) of the user.
role	Role that the user has.
sur-name	Surname of the user
ppid	Private identifier of the user.
name-identifier	SAML name identifier of the user.
authentication-method	Method used to authenticate the user.
deny-only-group-sid	Deny-only group SID of the user.
deny-only-primary-sid	Deny-only primary SID of the user.
deny-only-primary-group-sid	Deny-only primary group SID of the user.
group-sid	Group SID of the user.
primary-group-sid	Primary group SID of the user.
primary-sid	Primary SID of the user.
windows-account-name	Domain account name of the user in the form of <domain>\<user>.

group-name

Group name in assertion statement.

string

Maximum length: 255

idp-cert

IDP Certificate name.

string

Maximum length: 35

idp-entity-id

IDP entity ID.

string

Maximum length: 255

idp-single-logout-url

IDP single logout url.

string

Maximum length: 255

idp-single-sign-on-url

IDP single sign-on URL.

string

Maximum length: 255

limit-relaystate

Enable/disable limiting of relay-state parameter when it exceeds SAML 2.0 specification limits (80 bytes).

option

disable

Option	Description
enable	Enable limiting of relay-state parameter when it exceeds SAML 2.0 specification limits (80 bytes).
disable	Disable limiting of relay-state parameter when it exceeds SAML 2.0 specification limits (80 bytes).

name

SAML server entry name.

string

Maximum length: 35

realm *

FortiIdentity cloud realm.

string

Maximum length: 35

default

reauth

Enable/disable signalling of IDP to force user re-authentication (default = disable).

option

disable

Option	Description
enable	Enable signalling of IDP to force user re-authentication.
disable	Disable signalling of IDP to force user re-authentication.

require-signed-resp-and-asrt

Require both response and assertion from IDP to be signed when FGT acts as SP (default = disable).

option

disable

Option	Description
enable	Both response and assertion must be signed and valid.
disable	At least one of response or assertion must be signed and valid.

scim-client

SCIM client name.

string

Maximum length: 35

scim-group-attr-type

Group attribute type used to match SCIM groups (default = display-name).

option

display-name

Option	Description
display-name	Display name.
external-id	External ID.

scim-user-attr-type

User attribute type used to match SCIM users (default = user-name).

option

user-name

Option	Description
user-name	User name.
display-name	Display name.
external-id	External ID.
email	Email.

service-provider-address *

The address to handle SAML auth request. To include a port, append it after a colon.

string

Maximum length: 255

single-logout-url

SP single logout URL.

string

Maximum length: 255

single-sign-on-url

SP single sign-on URL.

string

Maximum length: 255

type *

SAML type.

option

custom

Option	Description
custom	Manually configure SAML.
fortiidentity-cloud	Automatically create a new SSO app on FortiIdentity cloud and setup it up

user-claim-type

User name claim in assertion statement.

option

upn

Option	Description
email	E-mail address of the user.
given-name	Given name of the user.
name	Unique name of the user.
upn	User principal name (UPN) of the user.
common-name	Common name of the user.
email-adfs-1x	E-mail address of the user when interoperating with AD FS 1.1 or ADFS 1.0.
group	Group that the user is a member of.
upn-adfs-1x	User principal name (UPN) of the user.
role	Role that the user has.
sur-name	Surname of the user
ppid	Private identifier of the user.
name-identifier	SAML name identifier of the user.
authentication-method	Method used to authenticate the user.
deny-only-group-sid	Deny-only group SID of the user.
deny-only-primary-sid	Deny-only primary SID of the user.
deny-only-primary-group-sid	Deny-only primary group SID of the user.
group-sid	Group SID of the user.
primary-group-sid	Primary group SID of the user.
primary-sid	Primary SID of the user.
windows-account-name	Domain account name of the user in the form of <domain>\<user>.

user-name

User name in assertion statement.

string

Maximum length: 255

user-source *

FortiIdentity cloud user souce.

string

Maximum length: 35

uuid *

Universally Unique Identifier (UUID; automatically assigned but can be manually reset).

uuid

Not Specified

00000000-0000-0000-0000-000000000000

* This parameter may not exist in some models.

** Values may differ between models.

config user saml

SAML server entry configuration.

config user saml
    Description: SAML server entry configuration.
    edit <name>
        set adfs-claim [enable|disable]
        set cert {string}
        set clock-tolerance {integer}
        set digest-method [sha1|sha256]
        set entity-id {string}
        set fabric-force-sync [enable|disable]
        set fabric-object [enable|disable]
        set fabric-object-source [member|local|...]
        set group-claim-type [email|given-name|...]
        set group-name {string}
        set idp-cert {string}
        set idp-entity-id {string}
        set idp-single-logout-url {string}
        set idp-single-sign-on-url {string}
        set limit-relaystate [enable|disable]
        set realm {string}
        set reauth [enable|disable]
        set require-signed-resp-and-asrt [enable|disable]
        set scim-client {string}
        set scim-group-attr-type [display-name|external-id]
        set scim-user-attr-type [user-name|display-name|...]
        set service-provider-address {string}
        set single-logout-url {string}
        set single-sign-on-url {string}
        set type [custom|fortiidentity-cloud]
        set user-claim-type [email|given-name|...]
        set user-name {string}
        set user-source {string}
        set uuid {uuid}
    next
end

config user saml

Parameter

Description

Type

Size

Default

adfs-claim

Enable/disable ADFS Claim for user/group attribute in assertion statement (default = disable).

option

disable

Option	Description
enable	Enable ADFS Claim for user/group attribute in assertion statement.
disable	Disable ADFS Claim for user/group attribute in assertion statement.

cert

Certificate to sign SAML messages.

string

Maximum length: 35

clock-tolerance

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

integer

Minimum value: 0 Maximum value: 300

digest-method

Digest method algorithm.

option

sha256 **

Option	Description
sha1	Digest Method Algorithm is SHA1.
sha256	Digest Method Algorithm is SHA256.

entity-id

SP entity ID.

string

Maximum length: 255

fabric-force-sync *

Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped.

option

disable

Option	Description
enable	Enable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices.
disable	Disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices.

fabric-object *

Security Fabric global object setting.

option

disable

Option	Description
enable	Object is set as a security fabric-wide global object.
disable	Object is local to this security fabric member.

fabric-object-source *

Source of truth for fabric object.

option

root

Option	Description
member	Source of truth for this object is a non-root member of fabric.
local	Source of truth for this object is this security fabric member.
root	Source of truth for this object is the root of the fabric.

group-claim-type

Group claim in assertion statement.

option

group

Option	Description
email	E-mail address of the user.
given-name	Given name of the user.
name	Unique name of the user.
upn	User principal name (UPN) of the user.
common-name	Common name of the user.
email-adfs-1x	E-mail address of the user when interoperating with AD FS 1.1 or ADFS 1.0.
group	Group that the user is a member of.
upn-adfs-1x	User principal name (UPN) of the user.
role	Role that the user has.
sur-name	Surname of the user
ppid	Private identifier of the user.
name-identifier	SAML name identifier of the user.
authentication-method	Method used to authenticate the user.
deny-only-group-sid	Deny-only group SID of the user.
deny-only-primary-sid	Deny-only primary SID of the user.
deny-only-primary-group-sid	Deny-only primary group SID of the user.
group-sid	Group SID of the user.
primary-group-sid	Primary group SID of the user.
primary-sid	Primary SID of the user.
windows-account-name	Domain account name of the user in the form of <domain>\<user>.

group-name

Group name in assertion statement.

string

Maximum length: 255

idp-cert

IDP Certificate name.

string

Maximum length: 35

idp-entity-id

IDP entity ID.

string

Maximum length: 255

idp-single-logout-url

IDP single logout url.

string

Maximum length: 255

idp-single-sign-on-url

IDP single sign-on URL.

string

Maximum length: 255

limit-relaystate

Enable/disable limiting of relay-state parameter when it exceeds SAML 2.0 specification limits (80 bytes).

option

disable

Option	Description
enable	Enable limiting of relay-state parameter when it exceeds SAML 2.0 specification limits (80 bytes).
disable	Disable limiting of relay-state parameter when it exceeds SAML 2.0 specification limits (80 bytes).

name

SAML server entry name.

string

Maximum length: 35

realm *

FortiIdentity cloud realm.

string

Maximum length: 35

default

reauth

Enable/disable signalling of IDP to force user re-authentication (default = disable).

option

disable

Option	Description
enable	Enable signalling of IDP to force user re-authentication.
disable	Disable signalling of IDP to force user re-authentication.

require-signed-resp-and-asrt

Require both response and assertion from IDP to be signed when FGT acts as SP (default = disable).

option

disable

Option	Description
enable	Both response and assertion must be signed and valid.
disable	At least one of response or assertion must be signed and valid.

scim-client

SCIM client name.

string

Maximum length: 35

scim-group-attr-type

Group attribute type used to match SCIM groups (default = display-name).

option

display-name

Option	Description
display-name	Display name.
external-id	External ID.

scim-user-attr-type

User attribute type used to match SCIM users (default = user-name).

option

user-name

Option	Description
user-name	User name.
display-name	Display name.
external-id	External ID.
email	Email.

service-provider-address *

The address to handle SAML auth request. To include a port, append it after a colon.

string

Maximum length: 255

single-logout-url

SP single logout URL.

string

Maximum length: 255

single-sign-on-url

SP single sign-on URL.

string

Maximum length: 255

type *

SAML type.

option

custom

Option	Description
custom	Manually configure SAML.
fortiidentity-cloud	Automatically create a new SSO app on FortiIdentity cloud and setup it up

user-claim-type

User name claim in assertion statement.

option

upn

Option	Description
email	E-mail address of the user.
given-name	Given name of the user.
name	Unique name of the user.
upn	User principal name (UPN) of the user.
common-name	Common name of the user.
email-adfs-1x	E-mail address of the user when interoperating with AD FS 1.1 or ADFS 1.0.
group	Group that the user is a member of.
upn-adfs-1x	User principal name (UPN) of the user.
role	Role that the user has.
sur-name	Surname of the user
ppid	Private identifier of the user.
name-identifier	SAML name identifier of the user.
authentication-method	Method used to authenticate the user.
deny-only-group-sid	Deny-only group SID of the user.
deny-only-primary-sid	Deny-only primary SID of the user.
deny-only-primary-group-sid	Deny-only primary group SID of the user.
group-sid	Group SID of the user.
primary-group-sid	Primary group SID of the user.
primary-sid	Primary SID of the user.
windows-account-name	Domain account name of the user in the form of <domain>\<user>.

user-name

User name in assertion statement.

string

Maximum length: 255

user-source *

FortiIdentity cloud user souce.

string

Maximum length: 35

uuid *

Universally Unique Identifier (UUID; automatically assigned but can be manually reset).

uuid

Not Specified

00000000-0000-0000-0000-000000000000

* This parameter may not exist in some models.

** Values may differ between models.

Secure Networking

Hybrid Mesh Firewall

NOC Management

LAN

WAN

Unified SASE

Single Vendor SASE

Cloud Network Security

Secure Endpoint Connectivity

Web Application / API Protection

Security Operations

Security Operations Automation

Identity

Early Detection & Prevention

Secure Networking

Hybrid Mesh Firewall

NOC Management

LAN

WAN

Communication & Surveillance

Unified SASE

Single Vendor SASE

Secure Endpoint Connectivity

Cloud Network Security

Cloud-Native Security

Web Application / API Protection

Security Operations

Security Operations Automation

Endpoint

Data Protection

Identity

Email

Early Detection & Prevention

Expert Services

Edge Firewall

Orchestration & management

SD Branch

Application Delivery

Single Vendor SASE

Secure Endpoint Connectivity

Secure Private Access

Thin Edge

Identity

Application Gateway

Enterprise Asset Management

Endpoint Agent

Agentless Security Posture

Identity

Wireless

Switching

Identity

Privilege Acccess Management

Next Generation Firewall

Orchestration & management

Expert Services

Web Application / API Protection

All

All

Account Management

SAAS Management

SAAS Application Security

Managed Services

Platform as a service (PAAS)

Other SAAS Services

4D Pillars

Cloud

Popular Solutions

All Products

CLI Reference

config user saml

config user saml

config user saml

config user saml

config user saml

config user saml