From 4e323657c0bda96e296668394cc85c6af0e9b862 Mon Sep 17 00:00:00 2001 From: Maksymilian Chmiel Date: Fri, 19 Mar 2021 11:51:39 +0100 Subject: [PATCH] [IVMBASCZ-226] update, README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0ba8120..19ff28d 100644 --- a/README.md +++ b/README.md @@ -101,6 +101,7 @@ Parameter | Description | Default `logoutUrl` | An URL the endpoint responsible for handling logout procedure. It is exposed only if `bearerOnly` is set to false. | `/sso/logout` `apilogoutUrl` | An URL the endpoint responsible for handling logout procedure via a non-browser invocation (without redirects). | `/api/logout` `principalUrl` | An URL of the endpoint exposing resource owner's data (such as its name, ID token, access token etc.). Use `null` in order not to expose this endpoint at all. | `/api/principal` +`registerUrl` | An URL the endpoint responsible for handling registration. It is exposed only if `bearerOnly` is set to false. | `/sso/register` `principalConversion` | A function which alters principal representation exposed by `principalUrl` endpoint before it's sent in a response. Define this function if you don't want for example an access token to be exposed. | `undefined` (no conversion) `principalNameAttribute` | An access/ID token attribute which will be used as the principal name (user name). It will fallback to *sub* token attribute in case the *principalNameAttribute* is not present. Possible values are *sub*, *preferred_username*, *email*, *name*. | `name` `corsOrigin` | CORS for the `loginUrl` and `logoutUrl` endpoints. In production, only Keycloak server's FQDN should be defined here. | `['*']`