Config2_SAMLAuthenticator

SAML Single Sign-On configuration. Allows CompleteFTP users to authenticate via SAML identity providers.

Instances of this class are obtained from:

Properties

PropertyTypeDescription
company String

SAML attribute name for the user's company/organization.
emailAddress String

SAML attribute name for the user's email address.
enabled Boolean

Whether this authenticator is enabled.
givenName String

SAML attribute name for the user's given name (first name).
logInAsUser String

User to log in as when this authenticator succeeds.
profiles Config2_SAMLProfileManager

Profile manager for SAML identity providers.
siteUrl String

The URL of this CompleteFTP site (used for SAML assertions).
surname String

SAML attribute name for the user's surname (last name).
telephoneNumber String

SAML attribute name for the user's telephone number.
validateCerts Boolean

Whether to validate identity provider certificates.

Property Details

company :String

Description:

  • SAML attribute name for the user's company/organization.

SAML attribute name for the user's company/organization.

Type:
  • String

emailAddress :String

Description:

  • SAML attribute name for the user's email address.

SAML attribute name for the user's email address.

Type:
  • String

enabled :Boolean

Description:

  • Whether this authenticator is enabled.

Whether this authenticator is enabled.

Type:
  • Boolean

givenName :String

Description:

  • SAML attribute name for the user's given name (first name).

SAML attribute name for the user's given name (first name).

Type:
  • String

logInAsUser :String

Description:

  • User to log in as when this authenticator succeeds. If empty, the authenticated user's own account is used.

User to log in as when this authenticator succeeds. If empty, the authenticated user's own account is used.

Type:
  • String

profiles :Config2_SAMLProfileManager

Description:

  • Profile manager for SAML identity providers.

Profile manager for SAML identity providers.

Type:

siteUrl :String

Description:

  • The URL of this CompleteFTP site (used for SAML assertions).

The URL of this CompleteFTP site (used for SAML assertions).

Type:
  • String

surname :String

Description:

  • SAML attribute name for the user's surname (last name).

SAML attribute name for the user's surname (last name).

Type:
  • String

telephoneNumber :String

Description:

  • SAML attribute name for the user's telephone number.

SAML attribute name for the user's telephone number.

Type:
  • String

validateCerts :Boolean

Description:

  • Whether to validate identity provider certificates.

Whether to validate identity provider certificates.

Type:
  • Boolean