See Stacksync in action with a solution architect. Book a demo ↗

OKTA Stacksync

SSO and SCIM for OKTA

The Stacksync OKTA app is currently under review by OKTA. Until the app is published on OKTA marketplace, here is a guide to synchronize your OKTA users automatically into Stacksync by creating the SCIM app yourself

This setup takes ~10min

SSO is part of Stacksync Enterprise plan, you need to contact us at sso@stacksync.com to have set it up

Notes:

  • This setup needs to be implemented by an OKTA ADMIN
  • The SCIM integration is associated to a unique Stacksync workspace. If you have multiple workspaces (such as dev, stage and prod) you will need to set up an SCIM app for each of these Stacksync workspaces. Each workspace has independent RBAC enforcement.

SSO (SAML) setup instructions

  1. On your OKTA homepage go on the admin section

    Okta My Apps homepage with the "Admin" button highlighted in the top bar.
  2. In the Applications section, create an App integration of type SAML 2.0

    Okta Applications page with the "Create App Integration" button highlighted.
    Okta "Create a new app integration" dialog with sign-in method "SAML 2.0" selected and a Next button.
  3. Give the App name to Stacksync and you can add the Stacksync app logo (download file below)

stacksync_logo.png

stacksync_logo.png

image · 21KB

DownloadOpen
  1. Configure your SAML settings with:
    1. Single sign-on URL: https://auth.stacksync.com/login/callback?connection=<sso_id_provided_by_stacksync_team_for_you>
    2. Audience URI: urn:auth0:stacksync:<sso_id_provided_by_stacksync_team_for_you>
    3. Application username: Email
    4. Update application username on Create and update
    5. Attribute Statements:
      1. name=emails

      2. name format=Basic

      3. value=user.email

        Okta SAML Settings with Stacksync Single sign-on URL, Audience URI, Application username "Email" and attribute email = user.email.
    6. You can skip the Feedback section and click Finish
      1. Send us at sso@stacksync.com the following details:

        1. Identity Provider Single Sign-On URL at the top of the SAML setup instructions page.

          Okta sso_connection_demo app Sign On tab with the "View SAML setup instructions" button highlighted.
        Okta "How to Configure SAML 2.0" page with the Identity Provider Single Sign-On URL highlighted.

        2.SAML Signing Certificates for SHA2

        Okta SAML Signing Certificates with the SHA-2 Actions menu open, showing "View IdP metadata" and "Download certificate".
        1. Once we have received the above informations, we will activate SSO and you're all set! 🎉

SCIM setup instructions

  1. On the General page of the SAML app you just created, enable SCIM provisioning.

    Okta sso_connection_demo General tab App Settings with Edit and the "SCIM" provisioning option highlighted.
  2. Go to the Stacksync Workspace Settings page at https://app.stacksync.com to find the informations necessary for the next steps.

    1. Find your Stacksync workspace_id on top of the page.

      Stacksync Settings Workspace Details with the "Workspace Id" field (2610) highlighted.
    2. Generate a workspace_api_key at the bottom of the same page. Only the owner of the Stacksync workspace can Stacksync workspace api keys.

      Stacksync Settings page with the "Stacksync Workspace API Key" section highlighted: Key Name field and "Generate new API key" button.
  3. Go back to your SAML app on the Provisioning page. Fill in the following parameter:

    1. Base URL: https://api.stacksync.com/v1/workspaces/<your_stacksync_workspace_id>/scim/v2/

    2. API Token: Bearer <your_stacksync_workspace_api_key>

      Okta SCIM Connection: Stacksync base URL, unique identifier "email", provisioning actions checked, HTTP Header Bearer authorization.
  4. Allow your SCIM app to create, update and deactivate users. Stacksync users never use passwords to connect to Stacksync therefore the Sync Password feature should be disabled.

    Okta Provisioning to App with Create Users, Update User Attributes and Deactivate Users enabled and Sync Password unchecked.
  5. Go to the Profile Editor and add a new Attribute a new rolesto the app. This is a standard SCIM attribute with the following fields:

    1. Data type: string array

    2. Display name: roles

    3. Variables name: roles

    4. External name: roles

    5. External namespace: urn:ietf:params:scim:schemas:core:2.0:User

    6. Description: SCIM role attribute for Stacksync app

    7. Enum: true

    8. Attribute member: viewer and editor

    9. Attribute required: true

    10. Attribute type: Group

    11. Group Priority: Use Group Priority

      Okta Add Attribute dialog for a "roles" string array with enum members Viewer/viewer and Editor/editor, Group type, Use Group Priority.
  6. Go to Directory/Groups, create 2 groups: Stacksync Editors and Stacksync Viewers. Each group will be assigned a different role in Stacksync (editor and viewer)

    Okta Directory Groups page with the "Add group" button highlighted, used to create Stacksync Editors and Viewers groups.
  7. Assign to the Stacksync Groups you just created the people you want to give access to Stacksync

    Okta "Stacksync Editors" group People tab with the "Assign people" button highlighted.
  8. Go back to your application and under Assignments assign these 2 groups to the application. Make sure you select the right role for each group. You can ignore the other fields, Stacksync is not reading them.

    Okta sso_connection_demo app Assignments tab with the "Assign" dropdown and "Groups" filter highlighted.

That's it! 🎉

On this page