Skip to content

Commit

Permalink
doc(oidc): move example JSON to downloadable file #9268
Browse files Browse the repository at this point in the history
  • Loading branch information
poikilotherm committed Oct 2, 2023
1 parent 42d1812 commit bb0ba9a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"id":"<a unique id>",
"factoryAlias":"oidc",
"title":"<a title - shown in UI>",
"subtitle":"<a subtitle - currently unused in UI>",
"factoryData":"type: oidc | issuer: <issuer url> | clientId: <client id> | clientSecret: <client secret> | pkceEnabled: <true/false> | pkceMethod: <PLAIN/S256/...>",
"enabled":true
}
17 changes: 5 additions & 12 deletions doc/sphinx-guides/source/installation/oidc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,18 +95,11 @@ Provision via REST API
Note: you may omit the PKCE related settings from ``factoryData`` below if you don't plan on using PKCE - default is
disabled.

Please create a ``my-oidc-provider.json`` file like this, replacing every ``<...>`` with your values:

.. code-block:: json
{
"id":"<a unique id>",
"factoryAlias":"oidc",
"title":"<a title - shown in UI>",
"subtitle":"<a subtitle - currently unused in UI>",
"factoryData":"type: oidc | issuer: <issuer url> | clientId: <client id> | clientSecret: <client secret> | pkceEnabled: <true/false> | pkceMethod: <PLAIN/S256/...>",
"enabled":true
}
Please create a :download:`my-oidc-provider.json <../_static/installation/files/root/auth-providers/oidc.json>` file, replacing every ``<...>`` with your values:

.. literalinclude:: /_static/installation/files/root/auth-providers/oidc.json
:name: oidc-provider-example
:language: json

Now load the configuration into your Dataverse installation using the same API as with :doc:`oauth2`:

Expand Down

0 comments on commit bb0ba9a

Please sign in to comment.