Fortinet white logo
Fortinet white logo

CLI Reference

system saml

system saml

Use this command to configure FortiMail to act as a SAML SSO service provider (SP).

In Security Assertion Markup Language (SAML) SSO, you must configure both of these to connect and authenticate with each other:

  • FortiMail, which is the service provider (SP)
  • FortiAuthenticator or other remote authentication server, which is the identity provider (IdP). See profile sso.

When you enable SSO, FortiMail automatically generates its SP metadata XML, entity ID, and ACS URL. (To download them, use the GUI.)

Syntax

config system saml

set status {enable | disable}

set dynamic-ip-status {enable | disable}

set dynamic-ip {<client_ipv4/mask>,...}

set sp-entity-id "<entity-id_str>"

set second-sp-status {enable | disable}

set second-sp-entity-id <str>

end

Variable

Description

Default

status {enable | disable}

Enable or disable the feature.

disable

dynamic-ip {<client_ipv4/mask>,...}

Enter the IdP's client IP addresses or subnet in CIDR or dotted decimal format. Separate multiple IP addresses or subnets with a comma. Spaces are not allowed. If no IP range is specified, then any IP address is allowed.

Tip: For better security, only allow IdP communications from known IP addresses.

dynamic-ip-status {enable | disable}

Enable if the IdP uses dynamic client IP addresses, even within the same SAML session. (This can be useful, for example, if the IdP is deployed behind a load balancer.) Also configure dynamic-ip {<client_ipv4/mask>,...}.

disable

sp-entity-id "<entity-id_str>"

Enter the globally unique entity identifier for FortiMail admin GUI when it connects to the IdP, such as:

https://FortiMail.example.com/sp

Caution

Unlike system saml,the entity ID is not a URL; it is a uniform resource identifier (URI). This means that the entity ID is not required to be resolvable by DNS. It only must accurately reflect the organization that owns the SP, and be globally unique. As a result, it can be different from the FortiMail domain name and system saml. Your IdP might require a specific name or format because it is the central control point for federated SPs.

second-sp-status {enable | disable}

Enable the second service provider. Starting from v7.6.4, you can use two separate service provider (SP) entities for admin access (https://fortimail-hostname-or-ip/admin) and webmail access (https://fortimail-hostname-or-ip) respectively.

second-sp-entity-id <str>

Enter the globally unique entity identifier for FortiMail webmail when it connects to the IdP, such as:

https://FortiMail.example.com/sp2

Related topics

profile sso

system appearance

system saml

system saml

Use this command to configure FortiMail to act as a SAML SSO service provider (SP).

In Security Assertion Markup Language (SAML) SSO, you must configure both of these to connect and authenticate with each other:

  • FortiMail, which is the service provider (SP)
  • FortiAuthenticator or other remote authentication server, which is the identity provider (IdP). See profile sso.

When you enable SSO, FortiMail automatically generates its SP metadata XML, entity ID, and ACS URL. (To download them, use the GUI.)

Syntax

config system saml

set status {enable | disable}

set dynamic-ip-status {enable | disable}

set dynamic-ip {<client_ipv4/mask>,...}

set sp-entity-id "<entity-id_str>"

set second-sp-status {enable | disable}

set second-sp-entity-id <str>

end

Variable

Description

Default

status {enable | disable}

Enable or disable the feature.

disable

dynamic-ip {<client_ipv4/mask>,...}

Enter the IdP's client IP addresses or subnet in CIDR or dotted decimal format. Separate multiple IP addresses or subnets with a comma. Spaces are not allowed. If no IP range is specified, then any IP address is allowed.

Tip: For better security, only allow IdP communications from known IP addresses.

dynamic-ip-status {enable | disable}

Enable if the IdP uses dynamic client IP addresses, even within the same SAML session. (This can be useful, for example, if the IdP is deployed behind a load balancer.) Also configure dynamic-ip {<client_ipv4/mask>,...}.

disable

sp-entity-id "<entity-id_str>"

Enter the globally unique entity identifier for FortiMail admin GUI when it connects to the IdP, such as:

https://FortiMail.example.com/sp

Caution

Unlike system saml,the entity ID is not a URL; it is a uniform resource identifier (URI). This means that the entity ID is not required to be resolvable by DNS. It only must accurately reflect the organization that owns the SP, and be globally unique. As a result, it can be different from the FortiMail domain name and system saml. Your IdP might require a specific name or format because it is the central control point for federated SPs.

second-sp-status {enable | disable}

Enable the second service provider. Starting from v7.6.4, you can use two separate service provider (SP) entities for admin access (https://fortimail-hostname-or-ip/admin) and webmail access (https://fortimail-hostname-or-ip) respectively.

second-sp-entity-id <str>

Enter the globally unique entity identifier for FortiMail webmail when it connects to the IdP, such as:

https://FortiMail.example.com/sp2

Related topics

profile sso

system appearance