-
Notifications
You must be signed in to change notification settings - Fork 27
SSO & user management UPX #583
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
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
b20931e
security SSO UPX
fiquick 92f78b9
add sso images
fiquick b96487d
edit sso
fiquick 5150269
edit
AlexicaWright a973343
Merge branch 'console' into securityandrolesjessica
AlexicaWright cd1c469
add role mapping
fiquick b6f1609
Update modules/ROOT/pages/security/single-sign-on.adoc
fiquick 5524955
Update modules/ROOT/pages/security/single-sign-on.adoc
fiquick 060a17d
Update user-management.adoc
fiquick b26a9ec
Update single-sign-on.adoc
fiquick 6135606
Update single-sign-on.adoc
fiquick File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
[[aura-reference-security]] | ||
= Single Sign-On (SSO) | ||
:description: SSO allows you to log in to the Aura Console using their company IdP credentials. | ||
|
||
label:AuraDB-Virtual-Dedicated-Cloud[] | ||
label:AuraDB-Business-Critical[] | ||
label:AuraDS-Enterprise[] | ||
|
||
== SSO levels | ||
|
||
Organization admins can configure SSO at the organization-level and project-level. | ||
SSO is a log-in method. | ||
Access, roles, and permissions are dictated by role-based access control (RBAC). | ||
|
||
* *Organization-level:* Allows org admins to control how users log in when they are trying to access the organization. It is a log-in method for the Aura console. | ||
|
||
* *Project-level:* Impacts new database instances created within that project. | ||
It ensures users logging in with SSO have access to the database instances within the project. | ||
It depends on RBAC if the user can access and view or modify data within the instances themselves. | ||
For this level, the role mapping may be used to grant users different levels of access based on a role in their identity provider (IdP). | ||
It *does not* give access to edit the project settings, for example to edit the project name, network access, or to edit the instance settings such as to rename an instance, or pause and resume. | ||
|
||
== Log-in methods | ||
|
||
Log-in methods are different for each SSO level. | ||
Administrators can configure a combination of one or more of the log-in methods. | ||
|
||
*Organization-level supports:* | ||
|
||
* Email/password | ||
* Okta | ||
* Microsoft Entra ID | ||
* Google SSO (not Google Workspace SSO) | ||
|
||
*Project-level supports:* | ||
|
||
* User/password | ||
* Okta | ||
* Microsoft Entra ID | ||
|
||
At the project-level admins cannot disable user/password, but at the organization-level admins can disable email/password and Google SSO as long as there is at least one other custom SSO provider configured. | ||
|
||
== Setup requirements | ||
|
||
Accessing Aura with SSO requires: | ||
|
||
* Authorization Code Flow | ||
* A publicly accessible IdP server | ||
|
||
To create an SSO Configuration, either a Discovery URI or a combination of Issuer, Authorization Endpoint, Token Endpoint, and JWKS URI is required. | ||
|
||
== Create a new SSO configuration | ||
|
||
From the *Organization settings*, go to *Single Sign-On* to set up a new SSO configuration. | ||
|
||
The checkboxes *Use as a log in for the Organization* and *Use as login method for instances with projects in this Org* define whether SSO should be only on Organization level, only on Project level, or both. | ||
|
||
The required basic SSO configuration information can be retrieved from the IdP. | ||
Entering the Discovery URI pre-fills the fields below. | ||
If this is not known these fields can be completed manually. | ||
|
||
.SSO configuration | ||
[.shadow] | ||
image::sso.png[A screenshot of the SSO configuration,640,480] | ||
|
||
== Role mapping | ||
|
||
Role mapping applies to all new instances in the selected project. | ||
To configure role mapping for an individual instance, contact support. | ||
|
||
== Individual instance-level | ||
|
||
Support can assist with SSO configurations at instance-level including: | ||
|
||
* Role mapping specific to a database instance | ||
* Custom groups claim besides `groups` | ||
* Updating SSO on already running instances | ||
|
||
If you require support assistance, visit link:https://support.neo4j.com/[Customer Support] and raise a support ticket including the following information: | ||
|
||
|
||
. The _Project ID_ of the projects you want to use SSO for. Click on the project settings to copy the ID. | ||
|
||
. The name of your IdP |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.