Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add native okta docs #368

Merged
merged 2 commits into from
Sep 3, 2020
Merged

add native okta docs #368

merged 2 commits into from
Sep 3, 2020

Conversation

drewbanin
Copy link
Collaborator

Description & motivation

Adds docs for configuring Okta SSO natively in the application

Pre-release docs

Is this change related to an unreleased version of dbt?

  • Yes: please update the base branch to next
  • No: please ensure the base branch is current
  • Unsure: we'll let you know!

Checklist

If you added new pages (delete if not applicable):

  • The page has been added to website/sidebars.js
  • The new page has a unique filename


<Lightbox src="/img/docs/dbt-cloud/dbt-cloud-enterprise/61d2b48-Screen_Shot_2019-04-25_at_6.05.23_PM.png" title="The 'SAML Settings' page"/>
<!-- TODO : Will users need to change the Name ID format and Application
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kwigley would love to hear your thoughts on this part in particular. I saw an example where you set these fields to Email Address explicitly. Is that a configuration that we should document here?

Copy link
Contributor

@saouderkirk saouderkirk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm , adding a few questions but no blockers

@@ -0,0 +1,84 @@
---
title: "Setting up SSO with Okta (Deprecated)"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the 'Deprecated' ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we followed this pattern for GSuite and Azure too. The "deprecated" docs instruct users to send us their SSO creds for setup on our end. Now that this is all self-service, we specifically do not want folks to send their creds our way!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and, we intend to promote the native integrations as the recommended/primary way of integrating dbt Cloud with an SSO provider going forwards

### Create a new application

Log into your Okta account. You'll need administrator access to your Okta organization to follow this guide.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I poked around Okta a little - doesn't look like there's an easy link to provide here that would generalize to a list of admins on a given company's subdomain. Would have been a nice touch 😅

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about adding some inputs to the top of the page for:

  • your Okta domain
  • your dbt Cloud domain

And we could use those inputs to render specific docs for different users :). Let's do that in the v2!

* **Single sign on URL**: `https://auth.getdbt.com/login/callback?connection=<your-deployment-id>`
* **Audience URI (SP Entity ID)**: `urn:auth0:dbt-cloud:<your-deployment-id>`

Replace `<your-deployment-id>` with your dbt Cloud deployment ID. If you aren't sure what value you should use, please contact support ([email protected]).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there somewhere that this is surfaced within the cloud app, so folks could self serve this rather than contacting support?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these are the old/deprecated docs - users won't need to do this part anymore! There is no more deployment id :)

* **Name format**: Unspecified
* **Value**: `${user.email}`

Under **Group Attribute Statments**, enter the following:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be Statements I bet

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just to give you the lay of the land: I renamed the existing setting-up-sso-with-okta.md file to setting-up-sso-with-okta-deprecated.md. This file is unedited from it's previous version, and we'd probably anticipate deleting it in the future. All of the new docs are in the not-deprecated page!

@drewbanin
Copy link
Collaborator Author

I'm going to merge this as the native Okta integration is now live in dbt Cloud

@drewbanin drewbanin merged commit 38045c1 into current Sep 3, 2020
nghi-ly pushed a commit that referenced this pull request Feb 13, 2024
REPO SYNC - Public to Private
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants