> For the complete documentation index, see llms.txt.
Skip to main content

Check out Port for yourself ➜ 

SAML

This documentation will describe the process of integrating a SAML application with Port, along with some examples for specific identity providers.

In order to integrate Port with a SAML SSO application, you will need to do the following:

  1. Create a new SAML application in your identity provider.
  2. In the Configure Connection section of the Port setup flow, provide your IdP credentials using one of the following options:
    • Automatic - paste your IdP's metadata URL to auto-populate the connection settings.
    • Manual - upload the PEM certificate (.pem file) and enter the Single Sign-On login URL from your identity provider.
  3. In the same Configure Connection section, open Advanced settings and set the following:
    • Sign Request Algorithm: RSA-SHA256
    • Sign Request Algorithm Digest: SHA256
    • Protocol Binding: HTTP-Post
  4. If your identity provider requires a SAML metadata XML file, create an XML file containing the relevant URL below (based on your region) and upload it to your SAML application to complete the connection:

  • EU: https://auth.getport.io/samlp/metadata?connection=company-<companyID>-SSO

  • US: https://auth.us.getport.io/samlp/metadata?connection=company-<companyID>-SSO

    Replace company-<companyID>-SSO with your connection name (see the prerequisites in the self-serve SSO guide for how to find it).

  1. Update the application with the following attributes (Port expects the IdP to send the following attributes and their values in the authentication request, for example: firstname is the attribute in the IdP provider, and given_name is the key Port expects to receive that data in the authorization mapping):
    • User attribute mappings - target attribute name (Port): source attribute name (SSO app):
      • email: email
      • given_name: firstname
      • family_name: lastname
    • Constant attributes:
      • email_verified: true If your login provider does not support metadata files, use the following information:
  • IdP EntityID:
    • https://auth.getport.io (EU)
    • https://auth.us.getport.io (US)
Finding your connection name

Your connection name follows the format company-<companyID>-SSO. You can find it in the Single Sign-On URL shown during the self-serve SSO setup flow. Look for the connection parameter in the URL.

  • SP EntityID:
    The EntityDescriptor field in the XML, looks like : urn:auth0:port-prod:company-<companyID>-SSO.

  • Callback URL:
    The AssertionConsumerService binding field in the XML, looks like the URL below:

    • https://auth.getport.io/login/callback?connection=company-<companyID>-SSO (EU)
    • https://auth.us.getport.io/login/callback?connection=company-<companyID>-SSO (US)