{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Applies to","type":"text","marks":[{"type":"strong"}]},{"text":": ","type":"text"},{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" Kyvos Enterprise ","type":"text"},{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" Kyvos Cloud (SaaS on AWS) ","type":"text"},{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" Kyvos AWS Marketplace","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" Kyvos Azure Marketplace ","type":"text"},{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" Kyvos GCP Marketplace ","type":"text"},{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" Kyvos Single Node Installation (Kyvos SNI) ","type":"text"}]},{"type":"rule"},{"type":"panel","attrs":{"panelIconId":"atlassian-note","panelIcon":":note:","panelColor":"#DEEBFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Note ","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"From Kyvos 2024.1 onwards, a restart of the Kyvos Web Portal will not be required for Kyvos security configuration (Web based SSO).","type":"text"}]}]},{"type":"paragraph","content":[{"text":"To configure SAML2.0 as an external authentication provider for the Kyvos Web Portal, perform the following steps. ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On the navigation pane, click ","type":"text"},{"text":"Security","type":"text","marks":[{"type":"strong"}]},{"text":" > ","type":"text"},{"text":"Web based SSO","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"},{"type":"hardBreak"},{"text":"The ","type":"text"},{"text":"Web Based SSO","type":"text","marks":[{"type":"strong"}]},{"text":" dialog is displayed. ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center","width":500,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":600,"id":"53c31818-ac78-4646-9121-be6633f3cc93","collection":"contentId-292999364","type":"file","height":600},"marks":[{"type":"border","attrs":{"size":1,"color":"#091e4224"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select the ","type":"text"},{"text":"Enable External Authentication","type":"text","marks":[{"type":"strong"}]},{"text":" check box to define the external authentication mechanism for the Kyvos Web portal.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select the SAML2.0 option from the","type":"text"},{"text":" Provider","type":"text","marks":[{"type":"strong"}]},{"text":" list.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enter details as:","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"

Parameter/Field	Comments/Description
Header Name	Enter the name of the HTTP header that contains the user name in the HTTP request.
Header Type	Select the type of value to be sent by the external authentication tool as an SSO token.
Error Redirection URL	Enter the URL to which the user will be redirected if there is an error in authenticating the Kyvos application with SAML2.0. This option is displayed only if SAML2.0 is selected as an external authentication provider. Both relative and absolute URLs are supported. Example: /error/exception.jsp and http://host:port/appname
Service Provider Single Sign-On Return URL	Enter the Kyvos Web Portal URL, on which the application redirects after a single sign-on.
Service Provider Issuer	Enter the name of the service provider issuer to identify your Kyvos Server installation to the Identity Provider. You can use your Kyvos Web Server URL here.
X.509 Certificate File	Upload the standard format certificate (X.509) file. This is a Privacy Enhanced Mail (PEM)-encoded x509 certificate with the .crt file extension.
Service Provider Key File	Upload the service provider's private key file. This is an RSA or DSA private key file with .key extension. This is not password protected.
Single Logout URL	Enter the identity provider's single sign-out URL.
Single Sign-On URL	Enter a single sign-on URL. This is the URL generated by SAML2.0 while integrating the Kyvos application.
Identity Provider Issuer	Enter identity provider issuer as generated by SAML2.0.
X.509 Certificate File	Upload the X.509 certificate file for SAML2.0.

","block-inline":true,"nestedContent":{"type":"doc","content":[{"type":"table","attrs":{"layout":"full-width"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[199.92]},"content":[{"type":"paragraph","content":[{"text":"Parameter/Field","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[773.44]},"content":[{"type":"paragraph","content":[{"text":"Comments/Description","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[199.92]},"content":[{"type":"paragraph","content":[{"text":"Header Name","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[773.44]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the HTTP header that contains the user name in the HTTP request.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[199.92]},"content":[{"type":"paragraph","content":[{"text":"Header Type","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[773.44]},"content":[{"type":"paragraph","content":[{"text":"Select the type of value to be sent by the external authentication tool as an SSO token.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[199.92]},"content":[{"type":"paragraph","content":[{"text":"Error Redirection URL","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[773.44]},"content":[{"type":"paragraph","content":[{"text":"Enter the URL to which the user will be redirected if there is an error in authenticating the Kyvos application with SAML2.0. This option is displayed only if SAML2.0 is selected as an external authentication provider. ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"type":"hardBreak"},{"text":" Both relative and absolute URLs are supported. ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"type":"hardBreak"},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"Example: ","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"/error/exception.jsp and ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"http://host:port/appname","type":"text","marks":[{"type":"link","attrs":{"href":"http://hostport"}},{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[199.92]},"content":[{"type":"paragraph","content":[{"text":"Service Provider Single Sign-On Return URL","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[773.44]},"content":[{"type":"paragraph","content":[{"text":"Enter the Kyvos Web Portal URL, on which the application redirects after a single sign-on.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[199.92]},"content":[{"type":"paragraph","content":[{"text":"Service Provider Issuer","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[773.44]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the service provider issuer to identify your Kyvos Server installation to the Identity Provider. You can use your Kyvos Web Server URL here.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[199.92]},"content":[{"type":"paragraph","content":[{"text":"X.509 Certificate File","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[773.44]},"content":[{"type":"paragraph","content":[{"text":"Upload the standard format certificate (X.509) file. This is a Privacy Enhanced Mail (PEM)-encoded x509 certificate with the ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":".crt","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":" file extension.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[199.92]},"content":[{"type":"paragraph","content":[{"text":"Service Provider Key File","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[773.44]},"content":[{"type":"paragraph","content":[{"text":"Upload the service provider's private key file. This is an RSA or DSA private key file with .key extension. This is not password protected.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[199.92]},"content":[{"type":"paragraph","content":[{"text":"Single Logout URL","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[773.44]},"content":[{"type":"paragraph","content":[{"text":"Enter the identity provider's single sign-out URL.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[199.92]},"content":[{"type":"paragraph","content":[{"text":"Single Sign-On URL","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[773.44]},"content":[{"type":"paragraph","content":[{"text":"Enter a single sign-on URL. This is the URL generated by SAML2.0 while integrating the Kyvos application.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[199.92]},"content":[{"type":"paragraph","content":[{"text":"Identity Provider Issuer","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[773.44]},"content":[{"type":"paragraph","content":[{"text":"Enter identity provider issuer as generated by SAML2.0.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[199.92]},"content":[{"type":"paragraph","content":[{"text":"X.509 Certificate File","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#000000"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[773.44]},"content":[{"type":"paragraph","content":[{"text":"Upload the X.509 certificate file for SAML2.0.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]}]}]}]}],"version":1},"reason":"A table in list item can't be created or edited in the new editor."}}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click the ","type":"text"},{"text":"Save ","type":"text","marks":[{"type":"strong"}]},{"text":"button to save changes.","type":"text"}]}]}]}],"version":1}

Browser not supported