Connecting Enterprise PKS to a SAML Identity Provider

Page last updated:

This topic describes how to connect VMware Enterprise PKS to a SAML identity provider (IdP).

Overview

User Account and Authentication (UAA), the identity management service for Enterprise PKS, can authenticate users either through its internal user account store or external authentication mechanisms such as an LDAP server or a SAML IdP.

To enable an internal user account store for UAA, you select Internal UAA in the Enterprise PKS tile > UAA.

If you want to connect Enterprise PKS to a SAML IdP, you must integrate the UAA server with your SAML IdP by following the instructions in Integrate UAA with a SAML IdP below. This enables UAA to delegate authentication to your SAML IdP.

Prerequisites

Before you configure a SAML IdP in the Enterprise PKS tile, you must configure your IdP to designate Enterprise PKS as a service provider (SP).

See the table below for information about industry-standard SAML IdPs and how to integrate them with Enterprise PKS:

Solution Name Integration Guide
Okta Single Sign-On Configuring Okta as a SAML Identity Provider
Azure Active Directory Configuring Azure Active Directory as a SAML Identity Provider

Integrate UAA with a SAML IdP

To integrate UAA with a SAML IdP:

  1. In Enterprise PKS > UAA, under Configure your UAA user account store with either internal or external authentication mechanisms, select SAML Identity Provider.

    SAML Fields 1

  2. For Provider Name, enter a unique name you create for the IdP. This name can include only alphanumeric characters, +, _, and -. You must not change this name after deployment because all external users use it to link to the provider.

  3. For Display Name, enter a display name for your provider. This display name appears as a link on your Pivotal login page, which you can access at https://PKS-API:8443/login.

    SAML provider display name

  4. Retrieve the metadata from your IdP. You recorded your IdP metadata when you configured your IdP to designate Enterprise PKS as a SP. See Prerequisites above.

  5. Enter your IdP metadata into either the Provider Metadata or the Provider Metadata URL fields:

    • If your IdP exposes a metadata URL, enter it in Provider Metadata URL.
    • If your IdP does not expose a metadata URL, paste the XML you retrieved into Provider Metadata.

    Note: Pivotal recommends that you use the Provider Metadata URL rather than Provider Metadata because the metadata can change. You need to select only one of the above configurations. If you configure both, your IdP defaults to the (OR) Provider Metadata URL.

  6. For Name ID Format, select the name identifier format for your SAML IdP. This translates to username in Enterprise PKS. The default is Email Address.

    SAML Fields 2

  7. For First Name Attribute and Last Name Attribute, enter the attribute names in your SAML database that correspond to the first and last names in each user record. This field is case sensitive.

  8. For Email Attribute, enter the attribute name in your SAML assertion that corresponds to the email address in each user record, for example, EmailID. This field is case sensitive.

  9. For External Groups Attribute, enter the attribute name in your SAML database for your user groups. This field is case sensitive. To map the groups from the SAML assertion to admin roles in PKS, see Grant Enterprise PKS Access to an External SAML Group in Managing Enterprise PKS Users with UAA.

  10. By default, all SAML authentication requests from Enterprise PKS are signed. To change this, disable Sign Authentication Requests and configure your IdP to verify SAML authentication requests.

  11. To validate the signature for the incoming SAML assertions, enable Required Signed Assertions and configure your IdP to send signed SAML assertions.

  12. For Signature Algorithm, choose an algorithm from the dropdown to use for signed requests and assertions. The default value is SHA256.

  13. Click Save.

Complete Your Tile Configuration

Next Steps

For information about creating Enterprise PKS roles and managing Kubernetes cluster access, see:


Please send any feedback you have to pks-feedback@pivotal.io.