Welcome to the Botium Knowledge Center

Set the environment variable BOTIUMBOX_PASSPORT_STRATEGY to saml2

Add configuration with JSON file and/or other environment variables (see below)

Restart Botium

Download the SAML Service Provider (SP) Metadata file from /api/auth/saml2/metadata and use it to register Botium in your indentiy provider - this file looks like this and it is bound to the Botium URL:

<?xml version="1.0"?>
<EntityDescriptor xmlns="urn:oasis:names:tc:SAML:2.0:metadata" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" entityID="botiumbox-<botium-box-url>" ID="botiumbox_botium_box_url">
  <SPSSODescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">
    <NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</NameIDFormat>
    <AssertionConsumerService index="1" isDefault="true" Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="<botium-box-url>/api/auth/saml2/callback"/>
  </SPSSODescriptor>
</EntityDescriptor>

Botium will now show an additional option Sign in with Single Sign-On on the Login screen. It is still possible to use the internal Botium authentication, which is often used for administrative access.