Enabling a Custom SAML Identity Provider

By default, SAP Cloud Platform Identity Authentication is used by SAP Analytics Cloud. SAP Analytics Cloud also supports single sign-on (SSO) with using your identity provider (IdP).

Prerequisites

  • You must have an IdP that supports SAML 2.0 protocol.
  • You must be able to configure your IdP.
  • You must be assigned to the System Owner role in SAP Analytics Cloud. For more information, see Standard Application Roles.
  • SAP Analytics Cloud can be hosted either on SAP data centers or on non-SAP data centers. Determine which environment SAP Analytics Cloud is hosted in by inspecting yourSAP Analytics Cloud URL:
    • A single-digit number, for example us1 or jp1, indicates an SAP data center.
    • A two-digit number, for example eu10 or us30, indicates a non-SAP data center.
  • If your users are connecting from Apple devices using the SAP Analytics Cloud mobile app, the certificate used by your IdP must be compatible with Apple's App Transport Security (ATS) feature.

Procedure

  1. Go to Start of the navigation path (Main Menu) Next navigation step  System Next navigation step  Administration Next navigation step SecurityEnd of the navigation path.
  2. Select (Edit).
  3. In the Authentication Method area, select SAML Single Sign-On (SSO) if it is not already selected.
    Note
    By default, SAP Cloud Identity is used for authentication.
  4. In Step 1, select Download and save the metadata file.
    An SAP Analytics Cloud metadata file will be saved.
  5. Upload the SAP Analytics Cloud metadata file to your SAML IdP.
    The file includes metadata for SAP Analytics Cloud, and is used to create a trust relationship between your SAML Identity Provider and your SAP Analytics Cloud system.
  6. Map your SAML IdP user attributes and roles.

    If SAP Analytics Cloud is running on an SAP data center, you must submit an SAP Product Support Incident using the component LOD-ANA-BI. In the support ticket, indicate that you want to set up user profiles and role assignment based on custom SAML attributes, and include your SAP Analytics Cloud tenant URL

    If SAP Analytics Cloud is running on a non-SAP data center, you must configure your SAML IdP to map user attributes to the following case-sensitive white-listed assertion attributes:
    Attribute Name Notes
    email Required if your NameID is "email".
    Groups Required. Set to "sac".
    familyName Optional. familyName is the user's last name (surname).
    displayName Optional.
    functionalArea Optional.
    givenName Optional. givenName is the user's first name.
    preferredLanguage Optional.
    custom1 Optional. For SAML role assignment.
    custom2 Optional. For SAML role assignment.
    custom3 Optional. For SAML role assignment.
    custom4 Optional. For SAML role assignment.
    custom5 Optional. For SAML role assignment.
    Note

    If you are using the SAP Cloud Platform Identity Authentication service as your IdP, map the Groups attribute under Default Attributes for your SAP Analytics Cloud application. The remaining attributes should be mapped under Assertion Attributes for your SAP Analytics Cloud application.

  7. Download metadata from your SAML IdP.
  8. In Step 2, select Upload, and choose the metadata file you downloaded from your SAML IdP.
  9. In Step 3, select a User Attribute.
    The attribute will be used to map users from your existing SAML user list to SAP Analytics Cloud. The user attribute you select must match the NameID used in your custom SAML assertion:
    <NameID Format="urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified"><Your Unique Identifier></NameID>
    Determine what your NameID maps to in your SAP Analytics Cloud system. It should map to User ID, Email or a custom attribute. You can view your SAP Analytics Cloud user attributes in Start of the navigation pathSecurity Next navigation step UsersEnd of the navigation path.
    Note
    NameID is case sensitive. The User ID, Email, or Custom SAML User Mapping must match the values in your SAML IdP exactly. For example, if the NameId returned by your SAML IdP is user@company.com and the email you used in SAP Analytics Cloud is User@company.com the mapping will fail.
    Choose one of the following options:
    • USER ID: If NameID maps to the SAP Analytics Cloud User ID.
    • Email: If NameID maps to SAP Analytics Cloud Email address.
      Note
      If your NameID email is not case-sensitive and contains mixed-case, for example User@COMPANY.com, consider choosing Custom SAML User Mapping instead.
    • Custom SAML User Mapping: If NameID maps to a custom value.
      Note
      If you select this option, there will be a new column named SAML User Mapping in Start of the navigation pathSecurity Next navigation step UsersEnd of the navigation path. After switching to your SAML IdP, you must manually update this column for all existing users.
    Note

    If you are using a live connection to SAP S/4HANA Cloud Edition with OAuth 2.0 SAML Bearer Assertion, NameId must be identical to the user name of the business user on your SAP S/4HANA system.

    For example, if you want to map an SAP Analytics Cloud user with the user ID SACUSER to your SAP S/4HANA Cloud user with the user name S4HANAUSER, you must select Custom SAML User Mapping and use S4HANAUSER as the Login Credential in Step 10.

    If you are using SAP Cloud Identity as your SAML IdP, you can choose Login Name as the NameID attribute for SAP Analytics Cloud, then you can set the login name of your SAP Analytics Cloud user as S4HANAUSER.

  10. (Optional) Enable Dynamic User Creation.
    Note

    This option is unavailable for non-SAP data centers.

    When dynamic user creation is enabled, new users will be automatically created using the default role and will be able to use SAML SSO to log onto SAP Analytics Cloud. For more information, see Setting the Default Role. After users are created, you can set roles using SAML attributes. For more information, see Mapping Roles Using SAML Attributes.

    Note
    Automatic user deletion is not supported. If an user in SAP Analytics Cloud is removed from your SAML IdP, you must go to Start of the navigation pathSecurity Next navigation step UsersEnd of the navigation path and manually delete users. For more information, see Deleting Users.
  11. In Step 4, enter <Your Unique Identifier>.
    This value must identify the SAP Analytics Cloud system owner. The Login Credential provided here will be automatically set for your user.
    Note

    The Login Credential depends on the User Attribute you selected under Step 3.

  12. Test the SAML IdP setup, by logging into SAP Analytics Cloud with your IdP, and then clicking Verify Account to open a dialog for validation.

    In another browser, log on to the URL provided in the Verify Your Account dialog, using your SAML IdP credentials. You can copy the URL by selecting (Copy).

    You must use a private session to log onto the URL; for example, Guest mode in Chrome. This ensures that when you log on to the dialog and select SAP Analytics Cloud, you are prompted to log in and do not reuse an existing browser session.

    Note

    If SAP Analytics Cloud is running on a non-SAP data center, upon starting the verification step, you will see a new screen when logging into SAP Analytics Cloud. Two links will be displayed on this page. One will link to your current IdP and the other will link to the new IdP you will switch to. To do perform the Verify Account step, use the link for the new IdP. Other SAP Analytics Cloud users can continue logging on with the current IdP. Once you have completed Step 16 and the IdP switch has completed, this screen will no longer appear.

    If you can log on successfully, the SAML IdP setup is correct.
  13. In the Verify Your Account dialog, select Check Verification.
    If the verification was successful, a green border should appear around the Login Credential box.
  14. (Optional) Enter a password management URL.
    The URL should link to the password management page of your SAML IdP.
  15. Select (Save).
    The Convert to SAML Single Sign-On confirmation dialog will appear.
  16. Select Convert.
    When conversion is complete, you will be logged out and directed to the logon page of your SAML IdP.
  17. Log on to SAP Analytics Cloud with the credentials you used for the verification step.
  18. Go to Start of the navigation path Security Next navigation step  UsersEnd of the navigation path and look for the column of the User Attribute you selected in step 8.
    The values in this column should be a case sensitive match with the NameId sent by your IdP’s SAML assertion.
    Note
    If you selected Custom SAML User Mapping as User Attribute, you must manually update all fields in the SAML User Mapping column.

Results

Users will be able to use SAML SSO to log onto SAP Analytics Cloud.

Note
You can also set up your IdP with your Public Key Infrastructure (PKI) so that you can automatically log in your users with a client side X.509 certificate.

Next Steps

Disabling SAML SSO

To revert your system to the default IdP (SAP Cloud Identity) and disable your custom SAML IdP, do the following:
  1. Go to Start of the navigation path (Main Menu) Next navigation step  System Next navigation step  Administration Next navigation step SecurityEnd of the navigation path.
  2. Select (Edit).
  3. In the Authentication Method area, select SAP Cloud Identity (default).
  4. Select (Save).

When conversion is complete, you will be logged out and directed to the SAP Cloud Identity logon page.

Updating the SAML IdP Signing Certificate

If SAML SSO is enabled and the metadata from your IdP is updated with a new signing certificate, please submit an SAP Product Support Incident using the component LOD-ANA-BI. You must specify your SAP Analytics Cloud URL and attach the new metadata XML to the support incident.

Switch to a Different Custom IdP

If SAML SSO is enabled and you would like to switch to a different SAML IdP, you can repeat steps 1-18 using the new SAML IdP metadata.