Skip to main content

Configure SSO for Chef SaaS

Single Sign-On (SSO) is an authentication method that enables you to securely authenticate and use all services with just one set of credentials.

Chef SaaS SAML configuration

Chef SaaS users can log in using a SAML-based external Identity Provider (IdP).

Chef SaaS supports the following IdPs:

  • Azure AD
  • Microsoft 365
  • Okta
  • OneLogin
  • Ping
  • Tivoli Federated Identity Manager

Add SAML configuration

Note

It is crucial to note that your account must hold the Administrator policy to access the SSO user interface. This policy is automatically granted to members of the admin team.

Use the following instructions to add a SAML configuration in Chef SaaS.

  1. Log in to your Chef SaaS account and append /sso to your fully qualified domain name in your browser toolbar. For example, https://automate.example.com/sso.

  2. On the Chef SaaS SSO page, enter the following information:

    SSO URL
    The single sign-on URL provided by the IdP.
    Required
    Email Attribute
    The user email attribute is set in the IdP.
    Required
    Username Attribute
    The username attribute set in the IdP.
    Required
    Entity Issuer URL
    The authorization callback URL of your Chef SaaS deployment. The URL is your Chef SaaS deployment’s Fully Qualified Domain Name (FQDN) appended with dex/callback. For example, https://automate.example.com/dex/callback.
    Required
    CA Certificate
    The full certificate provided by the IdP. Include -----BEGIN CERTIFICATE----- and -----END CERTIFICATE----- at the beginning and end of the certificate string.
    Required
    Group Attribute
    The group attribute in the SAML assertion. If not provided, users authenticating with SSO will not be a member of any team.
    Optional
    Allowed Groups
    The groups in the IdP that have SSO access to Chef SaaS.
    Optional
    Name ID Policy Format
    The name identifier format used in the SAML AuthnRequest.
    Required for Microsoft 365 and Azure AD
    Default value: urn:oasis:names:tc:SAML:2.0:nameid-format:persistent.
    Possible values:
    • urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
    • urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
    • urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName
    • urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName
    • urn:oasis:names:tc:SAML:2.0:nameid-format:encrypted
    • urn:oasis:names:tc:SAML:2.0:nameid-format:entity
    • urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos
    • urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
    • urn:oasis:names:tc:SAML:2.0:nameid-format:transient

  3. After entering these fields, select Submit to add the user SSO configuration. After Chef SaaS validates all form values, the Submit button is enabled.

    The SSO page refreshes, showing the filled-in SAML configuration fields with a message at the top that says, “SSO Request is complete. Config applied successfully.”

If the new SSO configuration fails, you can edit and submit the form again.

Delete the SAML configuration

Your account must have the Administrator policy to access the SSO user interface. Members of the admins team have this by default.

As a user with the Administrator policy, you have the power to manage your SSO configurations. You can remove an existing SAML configuration in Chef SaaS by following these steps:

  1. Log in to your Chef SaaS account and append /sso to your FQDN in your browser toolbar. For example, https://automate.example.com/sso.

  2. Select Remove Configuration on the Chef SaaS SSO page.

  3. A dialog box asks you to confirm that you want to remove the configuration. Select Remove to remove the SSO configuration.

    The SSO page refreshes, showing empty SAML configuration fields and a message at the top that says, “SSO Request is complete. Config removed successfully.”

Thank you for your feedback!

×