Overview of Using SAML as an Authentication Server for Cloudpath
SAML 2.0 is an XML-based protocol that uses security tokens containing assertions to pass information about an end user between a SAML Identity Provider (IdP) and a SAML Service Provider (SP).
To establish trust between Cloudpath and a SAML IdP, configuration is required on both Cloudpath and the IdP.
Required Parameters
The following are required parameters with any SAML authentication:
- IdP Metadata URL: URL of the SAML metadata file. IdPs typically publish SAML metadata at a publicly available URL. The Cloudpath system periodically fetches the metadata from this URL to obtain configuration details about the desired SAML communication options the that IdP requires.
- Entity IDs: An entity ID is a globally unique
name for a SAML entity - either an IdP or an SP:
- IdP Entity ID: The IdP entityID is the identity of the identity provider. Example: https://idp_name.example.edu/idp
- SP Entity ID: The SP entityID is the
identity of the service provider. Example:
https://sp_name.example.edu/sp
Note: The SP Entity ID URI uniquely identifies the Cloudpath SAML authentication server as a Service Provider (SP) to the IdP. This becomes the entityID attribute of the EntityDescriptor element within the SP metadata XML that gets uploaded to the IdP. Changing this value after configuration has been completed requires the service provider metadata to be re-uploaded to the IdP.
Optional Parameters
The following are optional parameters with any SAML authentication that you can configure from the page in the web interface:
- Additional Logins - If Use for Admin Logins is
selected, administrators can log into the Cloudpath Admin UI using credentials
associated with this authentication server. Additionally, three related options
become available to define which Authentication Server-defined user groups are
allowed as Cloudpath administrators. They are:Group Regex options are used to map Authentication Server-defined groups to
Cloudpath administrator Roles. User groups returned by the authentication server
must match at least one of the Group Regex fields for the Admin login to be
allowed. While authenticating the admin user, if multiple regexes match, the
role with the highest privilege takes precedence. If none of the three regexes
match, authentication is denied to the user. If Use for Sponsor Logins is
selected, sponsors can log into the Cloudpath Sponsorship Portal using
credentials associated with this authentication server.
- One SAML definition shared between Administrator and Sponsor Logins: SAML authentication for end-user device enrollment (workflows) should use a separate SAML definition per workflow.
- Downloading SP
Metadata XML: After configuring a SAML authentication server
definition on Cloudpath, that is enabled for Administrator or Sponsor
Login, SP Metadata
XML is required to configure SAML IdP. On the Cloudpath web
interface, go to to view the list of SAML authentication servers. Click
the
icon next to server name to get the SP
Metadata XML.
The following are tenant-specific login pages, where the associated tenant account has SAML set up as an authentication server with Use For Admin Login and Use for Sponsor Login enabled.
SAML Administrator Login page:
- After the SAML authentication server is configured with the Use For Admin Logins option enabled, the Cloudpath Admin UI page displays the Sign in via SSO button. Click Sign in via SSO to initiate the SAML IdP login flow. If IdP login is successful, and if the groups returned by the SAML IdP meet at least one of the Group Regex settings, then the administrator is allowed access to the Cloudpath UI.
- For cloud or hosted versions of Cloudpath, a tenant-specific login URL is needed to access the Cloudpath UI through authentication servers external to Cloudpath. This URL is displayed within the expanded listing of the Authentication Server definitions in the page, under Admin Login URL.
- After the SAML authentication server is configured with the Use For Sponsor Logins option enabled, the Cloudpath Sponsor Portal login page displays the Sign in via SSO button. Click Sign in via SSO to initiate the SAML IdP login flow. If IdP login is successful, then the sponsor is allowed access to the Sponsor portal.
- For cloud or hosted versions of Cloudpath, a tenant-specific login URL is needed for externally authenticated Sponsors. This URL is displayed in the page, under Portal Look & Feel.
Proceeding With One of the Tested SAML Configurations
This document presents four different, tested methods that you can use in which SAML is the authentication server: