While specific individual steps vary based on your flavor of SAML Single Sign-On (SSO), at a high level, the overall process includes these steps:
- Add the KnowledgeOwl SP info to your SAML SSO provider, found in Security and access > Single sign-on in the Service provider metadata section.
- Add your IdP info to KnowledgeOwl in Security and access > Single sign-on in the Identity provider metadata section.
- Upload the IdP certificate from your SAML SSO provider to KnowledgeOwl in Security and access > Single sign-on in the Identity provider metadata section.
- Select Enable SAML SSO =in KnowledgeOwl in Security and access > Single sign-on in the SAML settings section, SAML SSO behavior subsection.
- Add the KnowledgeOwl x509 certificate to your IdP (found in Security and access > Single sign-on in the Service provider metadata section, SP metadata XML).
- Map SAML Attributes to fields in KnowledgeOwl to properly create reader accounts (SSO ID is required--you'll receive an error if you skip this step. Refer to Missing SSO ID mapping warning for more details)
- For existing attributes that directly map to KnowledgeOwl fields, use the SAML attribute map.
- To transform attribute values coming from your SSO provider (such as setting all readers to automatically be a member of one group in KnowledgeOwl), use Custom attribute map rules.
- To help with troubleshooting or to see the attribute values being passed, select Enable debug mode to troubleshoot issues in Security and access > Single sign-on in the SAML settings section. Then try logging in with an account through your SAML SSO provider--instead of logging in to the knowledge base, it will display the information that's being passed over from SSO to KnowledgeOwl, so you can ensure a) Info is being passed over, and b) That you have chosen the correct attributes for your mappings.
- Optional: To make it so that SAML SSO is the only access method for your knowledge base, select Require all readers to log in via SAML SSO in Security and access > Single sign-on in the SAML settings section.
- Optional: If you're using SAML SSO as your only or primary reader authentication mechanism, set the Unauthenticated access behavior in Security and access > Security settings to Redirect them to your SAML Login URL.
For more detailed, step-by-step instructions, see: