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

Single-sign on: general and SAML documentation #884

Merged
merged 17 commits into from
Jul 3, 2024
Merged

Conversation

antepusic
Copy link
Contributor

@antepusic antepusic commented Jul 1, 2024

Description

This PR adds documentation for the single sign-on feature. It includes:

  • updates to the general auth system (e.g. flag deprecation, module architecture, interactions with other systems within Memgraph)
  • SAML SSO documentation

Pull request type

Please check what kind of PR this is:

  • Fix or improvement of an existing page

Related PRs and issues

PR this doc page is related to:

memgraph/memgraph#1990
memgraph/memgraph#2049

Checklist:

  • Check all content with Grammarly
  • Perform a self-review of my code
  • Make corresponding changes to the rest of the documentation (consult with the DX team)
  • The build passes locally
  • My changes generate no new warnings or errors
  • Add a corresponding label
  • If release-related, add a product and version label
  • If release-related, add release note on product PR

@antepusic antepusic self-assigned this Jul 1, 2024
Copy link

vercel bot commented Jul 1, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 2, 2024 7:18pm

@antepusic antepusic added future release For one of the next versions status: ready PR is ready for review labels Jul 2, 2024
@antepusic antepusic requested a review from kgolubic July 2, 2024 12:59
@antepusic antepusic marked this pull request as ready for review July 2, 2024 13:00
@antepusic antepusic requested a review from hal-eisen-MG as a code owner July 2, 2024 13:00
Copy link
Contributor

@kgolubic kgolubic left a comment

Choose a reason for hiding this comment

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

Everything looks ok to me.

## Single sign-on

Single sign-on (SSO) lets you use an external ID to log in to Memgraph from
[Lab](data-visualization/user-manual/single-sign-on).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Verify that this and the other data-visualization/ links work once #797 is merged

Copy link
Contributor

@hal-eisen-MG hal-eisen-MG left a comment

Choose a reason for hiding this comment

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

LGTM

@kgolubic kgolubic merged commit 878b08d into memgraph-2-18 Jul 3, 2024
2 checks passed
kgolubic added a commit that referenced this pull request Jul 3, 2024
* Docs improvements (#799)

* Add NuRaft log file flag (#816)

* Add health checks docs (#833)

* Update HA examples

* Add NuRaft log file env (#848)

* Add leader/follower role (#857)

Co-authored-by: Antonio Filipovic <61245998+antoniofilipovic@users.noreply.github.com>

* Add coordinator hostname HA configuration option (#860)

* First leader

* Update pages/clustering/high-availability.mdx

Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>
Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>

* Add monitoring at runtime docs (#806)

* database-less connections update (#853)

* Update HA docs

* Add durability for coordinator (#859)

* add durability docs

* Update high-availability.mdx

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Edge type property index (#855)

* Add hops limit docs (#881)

* add docs for hops limit

* revert accidentally changed part of the docs

* fix grammar mistakes

* implement suggestions

* Peak memory observation in the system (#788)

* Peak memory observation in the system

* Update storage info where needed

* Update best practics

* Add information from PR review

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* removed flags (#854)

* Update envs for HA (#878)

* fix envs

* add 3 missing envs

* Update configuration.mdx

* Update configuration.mdx

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Add callout for important force reset  notice (#877)

* add callout for instance to be alive on force reset

* Update high-availability.mdx

* Enum datatype (v1) (#852)

* Add information around enums

* Add ALTER to the list of clauses

* Add ALTER to the list of Memgraph's Cypher extension

* Fix incorrect ALTER command

* Update pages/querying/clauses/create.mdx

* Update pages/querying/clauses/alter.mdx

* Update pages/querying/clauses/alter.mdx

* Update graph-modeling.md

* Address PR comments

---------

Co-authored-by: kgolubic <kgolubic@gmail.com>
Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* SSO Core - OIDC + OAuth2.0 docs (#876)

* wip oidc docs

* oidc sso docs

* PR changes and update

* update package info

* add startup info

* Update v2.18 experimental feature statuses (#871)

* Update v2.18 experimental feature statuses

* Join the sentances into paragraphs

* Update language and formatting

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>
Co-authored-by: kgolubic <kgolubic@gmail.com>

* Add postgresql migration docs (#867)

* Add postgresql migration docs

* Fix from PR review

* Single-sign on: general and SAML documentation (#884)

* Update the existing auth flags for v2.18

* Add a usage note for streams and triggers created by SSO users

* Update general (other than the SAML modules) auth functionalities

* Reorganize auth documentation to accommodate SSO

* Add SAML SSO docs (partial)

* Complete SAML docs

* Apply review suggestions

* Add remaining review suggestions

* Move OIDC docs next to SAML (since both are SSO)

* Fix trigger/stream × SSO usage note placement

* Remove duplicate entry and fix section tag

* Move section to the right place

* Apply suggestions

* Update direct download paths (#885)

* Migration tutorial from `RDBMS` using `MAGE` modules (#770)

* Memgraph 2.17 docs

* Docs

* Zoned datetime data type (#723)

* Document how zoned datetime is supported

* Fix formatting

* Update the Differences in Cypher implementation page

* Update min/max functions

* Revert "Zoned datetime data type (#723)" (#763)

This reverts commit 16c8157.

* Add migration tutorial from rdbms to memgraph

* Add fixes

* Fix from PR review

---------

Co-authored-by: kgolubic <kgolubic@gmail.com>
Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>
Co-authored-by: Ante Pušić <ante.pusic@memgraph.io>

* new: Add query sharing docs and update ENV variables for Lab (#865)

* new: Add a complete list of ENV variables

* new: Add query-sharing feature page

* Fix styling issues

* Update query-sharing.mdx

* new: Add more details for the query sharing

* Add images

* Insert images

* Insert images

* Fix paths

---------

Co-authored-by: kgolubic <kgolubic@gmail.com>
Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Added description how each user can change its own password (#819)

* Added description how each user can change its own password

* Update users.mdx

* Update users.mdx

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Add SSO docs (#797)

* Add docs for OAuth setup (WIP)

* Add docs for Okta OAuth

* Replace references to OAuth with OIDC

* Update single-sign-on.mdx

* new: Add SAML for Entra and Okta

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>
Co-authored-by: Toni Lastre <toni.lastre@memgraph.io>

* Create release notes for Memgraph 2.18 (#795)

* Update release notes

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update RN

* Update PR

* Update RN

* new: Add Lab 2.15 release notes (#866)

* new: Add Lab 2.15 release notes

* Update pages/release-notes.mdx

---------

Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>

* Update RN

* Update RN

---------

Co-authored-by: Toni <toni.lastre@memgraph.io>

* Remove support for Amazon Linux 2, CentOS 7 and RedHat 8

* Linked MAGE docs

* Update release notes

* Add callout for Breaking changes

* Add PR link

* Update Release notes

* Update pages/database-management/authentication-and-authorization/auth-system-integrations.mdx

Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>

* Fix indentation

---------

Co-authored-by: Andi <andi8647@gmail.com>
Co-authored-by: Antonio Filipovic <61245998+antoniofilipovic@users.noreply.github.com>
Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>
Co-authored-by: Josipmrden <josip.mrden@memgraph.io>
Co-authored-by: andrejtonev <29177572+andrejtonev@users.noreply.github.com>
Co-authored-by: Aidar Samerkhanov <aidar.samerkhanov@memgraph.io>
Co-authored-by: David Ivekovic <david.ivekovic@memgraph.io>
Co-authored-by: Gareth Andrew Lloyd <gareth@ignition-web.co.uk>
Co-authored-by: Ivan Milinović <44698587+imilinovic@users.noreply.github.com>
Co-authored-by: Marko Budiselić <marko.budiselic@memgraph.com>
Co-authored-by: Ante Pušić <ante.pusic@memgraph.io>
Co-authored-by: Toni <toni.lastre@memgraph.io>
Co-authored-by: tonijurjevic96 <168409767+tonijurjevic96@users.noreply.github.com>
Co-authored-by: David <davidlozic@gmail.com>
@kgolubic kgolubic deleted the sso-docs branch August 16, 2024 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
future release For one of the next versions status: ready PR is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants