Skip to content

Commit

Permalink
more about OIDC realm config
Browse files Browse the repository at this point in the history
  • Loading branch information
ymarcon committed Apr 8, 2021
1 parent 0ec6a94 commit f1c28c1
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions web-user-guide/realms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,19 @@ Agate is able to delegate authentication to alternate identity provider systems.
Realm Types
-----------

Open ID Connect Realm
~~~~~~~~~~~~~~~~~~~~~

A realm that uses the OpenID Connect (`OIDC <https://openid.net/connect/>`_) protocol to authenticate users.
:doc:`../oauth2-api/openid-connect-flow` explains the typical authentication flow when using this type of realm.

To register Agate as a client of the OIDC provider it will be necessary to provide its callback URL which is: ``https://agate.example.org/auth/callback/``.

.. note::
For Agate to authenticate for an :ref:`domain-application`, its redirect URI must be set.

An example of well known open source ID provider that can be declared as an OIDC realm is `Keycloak <https://www.keycloak.org/>`_. Keycloak has also a strong user federation feature, which we recommend to use instead of using the following other realm types (LDAP etc.).

LDAP Realm
~~~~~~~~~~

Expand All @@ -33,13 +46,3 @@ Salt styles include:
- ``CRYPT``: uses the database's underlying cryptographic method to decrypt the password.
- ``COLUMN``: the salt column must be the second column included in the query.
- ``EXTERNAL``: uses the specified algorithm to decrypt the password.


Open ID Connect Realm
~~~~~~~~~~~~~~~~~~~~~

A realm that uses the OpenID Connect (`OIDC <https://openid.net/connect/>`_) protocol to authenticate users.
:doc:`../oauth2-api/openid-connect-flow` explains the typical authentication flow when using this type of realm.

.. note::
For agate to authenticate for an :ref:`domain-application`, its redirect URI must be set.

0 comments on commit f1c28c1

Please sign in to comment.