Skip to content

SAML authentication

The SAML authentication method allows your users to log in to DeployBoard using a SAML compatible single sign-on provider.


Every SAML application should follow the same instructuions, although the steps to create an application within your SAML identity provider will differ slightly.


Create an Application

  1. Log in to the Google Admin Portal.

  2. Go to the Apps and select Web and mobile apps.

  3. Click the Add app dropdown and select Add custom SAML app.

  4. Enter a name for the App. We suggest: DeployBoard and click Continue.

  5. Click Download IdP metadata and save the .xml file for later. You can download this later in case you lose it or forget.

  6. Service provider details: a. ACS URL:${YourAccountName} a. Entity ID: a. Start URL: leave blank a. Signed response: leave unchecked

  7. Name ID: a. Name ID format: EMAIL a. Name ID: Basic Information > Primary email

  8. Click Continue to proceed to Attribute Mapping

  9. You can leave the Attriutes section empty.

  10. If you are using role mapping from Groups (you should be), add the groups you would like to be able to log into DeployBoard with. You will perform the role mappings in the DeployBoard interface. a. Google groups: Add the groups you would like to be able to log into DeployBoard. b. App attribute: This should be Groups. This is important since DeployBoard looks for this when the user logs in to perform automatic role mapping based on Group membership.


Create an Okta application

TODO: Add instructions

Role Mapping

In the SSO settings page, you can specify what groups in your SAML identity provider map to Admin, Editor, and User roles within DeployBoard. This means when onboarding a new user, you don't need to manually specify their role within DeployBoard, as it can be mapped back to a group in the identity provider.