Skip to content

Commit

Permalink
final fixups
Browse files Browse the repository at this point in the history
  • Loading branch information
proddata committed Jan 8, 2025
1 parent 4cbb14b commit 0f2ca60
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions docs/organization/access-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,19 @@ security of your account, follow these best practices:
### SSO with Google, Microsoft, or GitHub Social
CrateDB Cloud supports single sign-on (SSO) via Google, Microsoft, or GitHub.
Here's how to get started:
1. Sign up for CrateDB Cloud using your company email address or GitHub account.
2. Invite other users using their company email addresses or GitHub usernames.
1. Sign up for CrateDB Cloud using your company Google, Microsoft or GitHub account.
2. Invite other users using their company email addressess.

For organizations using Google or Microsoft SSO, this setup ensures users
authenticate through the organization's login processeither via your identity
provider or directly through Google or Microsoft authenticationbefore accessing
authenticate through the organization's login processeither via your identity
provider or directly through Google or Microsoft authenticationbefore accessing
CrateDB Cloud.

:::{note}
When signing in with an external authentication provider for the first time, a
CrateDB Cloud user account will be automatically generated for you.
:::

:::{note}
When using Google, Microsoft, or GitHub for authentication in CrateDB Cloud,
admin permissions might be required to configure and allow access, depending
Expand All @@ -40,17 +45,17 @@ on your organization's settings.
For **Microsoft**, admins may need to:
- Grant tenant-wide consent for the permissions requested by CrateDB Cloud
(`openid`, `profile`, `email`, and `offline_access`).
- Whitelist the CrateDB Cloud application if app registrations or third-party
- Allowlist the CrateDB Cloud application if app registrations or third-party
integrations are restricted.

For **Google**, admins might need to:
- Authorize the CrateDB Cloud application in the Google Admin Console under
"Apps > App Management."
"Apps > App Management".
- Enable external applications if they are restricted within your organization.

For **GitHub**, admins may need to:
- Approve the CrateDB Cloud application in the GitHub organization settings
under "Third-party access."
under "Third-party access".

Consult your admin team to ensure proper setup for CrateDB Cloud authentication.
:::
Expand Down

0 comments on commit 0f2ca60

Please sign in to comment.