Welcome to the Botium Knowledge Center

Place a file named saml2.config.json in the resources folder of your Botium Box installation. This is an example:

{
  "options": {
    "entryPoint": "https://sso.jumpcloud.com/saml2/botiumdevlocal",
    "cert": "jumpcloud.pem"
  },
  "autoCreateUser": true,
  "autoCreateRole": "GUEST",
  "propUsername": "nameID",
  "propEmail": "email",
  "propGroups": "memberOf",
  "group2Role": {
    "Administrator": "ADMIN",
    "Manager": "TESTMANAGER",
    "Tester": ["TESTER", "GUEST"]
  },
  "user2Role": {
    "admin": "ADMIN"
  }
}

SAML attribute name holding the username (default nameID), which is used to lookup the User records in Botium Box.

Also read from environment variable BOTIUMBOX_PASSPORT_SAML2_PROPERTY_USERNAME

SAML attribute name holding the email (default email)

Also read from environment variable BOTIUMBOX_PASSPORT_SAML2_PROPERTY_EMAIL

SAML attribute name holding the group or role names (default memberOf). They are mapped to Botium Box roles (see below).

Also read from environment variable BOTIUMBOX_PASSPORT_SAML2_PROPERTY_GROUPS

A role name that is automatically assigned to all created user records (default GUEST)

Also read from environment variable BOTIUMBOX_PASSPORT_SAML2_AUTOCREATE_ROLE

A boolean flag to let Botium Box automatically create user records that do not yet exist (default true)

Also read from environment variable BOTIUMBOX_PASSPORT_SAML2_AUTOCREATE_USER ("1" => true)

A mapping from the SAML2 groups or roles to Botium Box roles.

Also read from environment variable BOTIUMBOX_PASSPORT_SAML2_GROUP2ROLE

A mapping from the SAML2 user names to Botium Box roles.

Also read from environment variable BOTIUMBOX_PASSPORT_SAML2_USER2ROLE