From 7cf1161305eb495d84556762c1277a99b66d2759 Mon Sep 17 00:00:00 2001 From: girirajsharma Date: Wed, 14 Jan 2015 00:20:44 +0530 Subject: [PATCH] Minor changes : Fixed spell/grammatical errors in docbook. --- docbook/reference/en/en-US/modules/adapter-config.xml | 4 ++-- .../en/en-US/modules/application-clustering.xml | 2 +- docbook/reference/en/en-US/modules/clustering.xml | 2 +- .../en/en-US/modules/per-realm-admin-permissions.xml | 2 +- docbook/reference/en/en-US/modules/saml.xml | 6 +++--- docbook/reference/en/en-US/modules/social-github.xml | 2 +- docbook/reference/en/en-US/modules/themes.xml | 6 +++--- docbook/reference/en/en-US/modules/user-federation.xml | 10 +++++----- 8 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docbook/reference/en/en-US/modules/adapter-config.xml b/docbook/reference/en/en-US/modules/adapter-config.xml index 448f6ca2fb..a9d4e08a16 100755 --- a/docbook/reference/en/en-US/modules/adapter-config.xml +++ b/docbook/reference/en/en-US/modules/adapter-config.xml @@ -204,7 +204,7 @@ Specify the credentials of the application. This is an object notation where the key - is the credential type and the value if the value of the credential type. Currently only + is the credential type and the value is the value of the credential type. Currently only password is supported. This is REQUIRED. @@ -374,7 +374,7 @@ principal-attribute - OpenID Connection ID Token attribute to populate the UserPrincipal name with. If token attribute is null, defaults to sub + OpenID Connection ID Token attribute to populate the UserPrincipal name with. If token attribute is null, defaults to sub. Possible values are sub, preferred_username, email, name, nickname, given_name, family_name. diff --git a/docbook/reference/en/en-US/modules/application-clustering.xml b/docbook/reference/en/en-US/modules/application-clustering.xml index 1531d1e4b9..f332338dd1 100644 --- a/docbook/reference/en/en-US/modules/application-clustering.xml +++ b/docbook/reference/en/en-US/modules/application-clustering.xml @@ -95,7 +95,7 @@ This would mean that browser requests (like redirecting to Keycloak login screen) will be still resolved relatively to current request URI like https://loadbalancer.com/myapp, but backend (out-of-bound) requests between keycloak - and your app are send always to same cluster host with application . + and your app are sent always to same cluster host with application . Note that additionally to network optimization, diff --git a/docbook/reference/en/en-US/modules/clustering.xml b/docbook/reference/en/en-US/modules/clustering.xml index 350c47feeb..108c7f2443 100755 --- a/docbook/reference/en/en-US/modules/clustering.xml +++ b/docbook/reference/en/en-US/modules/clustering.xml @@ -155,7 +155,7 @@ messages to the cluster. However, as there's no sensitive data sent there's not much that can be achieved. For realms and users all that can be done is to send invalidation messages to make nodes load data from the database more frequently. For user sessions it would be possible to modify existing user sessions, but creating - new sessions would have no affect as they would not be linked to any access tokens. There's not to much that + new sessions would have no affect as they would not be linked to any access tokens. There's not too much that can be achieved by modifying user sessions. For example it would be possible to prevent sessions from expiring, by changing the creation time. However, it would for example have no effect adding additional permissions to the sessions as these are rechecked against the user and application when the token is created or refreshed. diff --git a/docbook/reference/en/en-US/modules/per-realm-admin-permissions.xml b/docbook/reference/en/en-US/modules/per-realm-admin-permissions.xml index 50803341a2..19f386330b 100755 --- a/docbook/reference/en/en-US/modules/per-realm-admin-permissions.xml +++ b/docbook/reference/en/en-US/modules/per-realm-admin-permissions.xml @@ -4,7 +4,7 @@ Administering your realm through the master realm as discussed in may not always be ideal or feasible. For example, maybe you have more than one admin application that manages various admin aspects of your organization and you want to unify all these different "admin consoles" under one realm so you can do SSO between them. Keycloak allows you to - grant realm admin privleges to users within that realm. These realm admins can participate in SSO for that realm and + grant realm admin privileges to users within that realm. These realm admins can participate in SSO for that realm and visit a keycloak admin console instance that is dedicated solely for that realm by going to the url: /{keycloak-root}/admin/{realm}/console diff --git a/docbook/reference/en/en-US/modules/saml.xml b/docbook/reference/en/en-US/modules/saml.xml index 5ba2e009e9..8cfd9722b5 100755 --- a/docbook/reference/en/en-US/modules/saml.xml +++ b/docbook/reference/en/en-US/modules/saml.xml @@ -18,7 +18,7 @@ Include AuthnStatement - SAML login responses may specify the authenticaiton method used (password, etc.) as well as + SAML login responses may specify the authentication method used (password, etc.) as well as a timestamp of the login. Setting this to on will include that statement in the response document. @@ -27,7 +27,7 @@ Multi-valued Roles - If this switch is off, any user role mapings will have a corresponding attribute created for it. + If this switch is off, any user role mappings will have a corresponding attribute created for it. If this switch is turn on, only one role attribute will be created, but it will have multiple values within in. @@ -82,7 +82,7 @@ By default, Keycloak will respond using the initial SAML binding of the original request. By turning on this switch, you will force Keycloak to always respond using the SAML POST Binding even if the - original request was a the Redirect binding. + original request was the Redirect binding. diff --git a/docbook/reference/en/en-US/modules/social-github.xml b/docbook/reference/en/en-US/modules/social-github.xml index 1890f87986..a4186e7ac8 100755 --- a/docbook/reference/en/en-US/modules/social-github.xml +++ b/docbook/reference/en/en-US/modules/social-github.xml @@ -20,7 +20,7 @@ Copy Client ID and Client secret from the GitHub Settings into the settings page in the Keycloak Admin Console as the Key and Secret. Then click - Save in the Keycloak Admin Console to enable login with Google. + Save in the Keycloak Admin Console to enable login with GitHub. diff --git a/docbook/reference/en/en-US/modules/themes.xml b/docbook/reference/en/en-US/modules/themes.xml index af3045398c..3996b3a0b0 100755 --- a/docbook/reference/en/en-US/modules/themes.xml +++ b/docbook/reference/en/en-US/modules/themes.xml @@ -25,7 +25,7 @@ Configure theme All theme types, except welcome, is configured through Keycloak Admin Console. To change - the theme used for a realm open the open the Keycloak Admin Console, select your realm + the theme used for a realm open the Keycloak Admin Console, select your realm from the drop-down box in the top left corner. Under Settings click on Theme. @@ -166,7 +166,7 @@ and org.keycloak.account.AccountProvider. - Once you have deployed your account provider to Keycloak you need to configure keycloak-server.jsonto specify which provider should be used: + Once you have deployed your account provider to Keycloak you need to configure keycloak-server.json to specify which provider should be used: "account": { "provider": "custom-provider" @@ -182,7 +182,7 @@ and org.keycloak.login.LoginFormsProvider in forms/login-api. - Once you have deployed your account provider to Keycloak you need to configure keycloak-server.jsonto specify which provider should be used: + Once you have deployed your account provider to Keycloak you need to configure keycloak-server.json to specify which provider should be used: "login": { "provider": "custom-provider" diff --git a/docbook/reference/en/en-US/modules/user-federation.xml b/docbook/reference/en/en-US/modules/user-federation.xml index b08a58b306..5eb1524419 100755 --- a/docbook/reference/en/en-US/modules/user-federation.xml +++ b/docbook/reference/en/en-US/modules/user-federation.xml @@ -19,7 +19,7 @@ federation plugins may only import the username into Keycloak storage, others might import everything from name, address, and phone number, to user role mappings. Some plugins might want to import credentials directly into Keycloak storage and let Keycloak handle credential validation. Others might want to handle credential validation - themselves. Thegoal of the Federation SPI is to support all of these scenarios. + themselves. The goal of the Federation SPI is to support all of these scenarios.
LDAP and Active Directory Plugin @@ -76,7 +76,7 @@ Display Name - Name used when this provider is referenced in the admin consle + Name used when this provider is referenced in the admin console @@ -118,7 +118,7 @@ first import this LDAP user into Keycloak database and then authenticate against LDAP password. - Thing is that Federation Provider import just requested users by default, so if you click to View all users + Federation Provider imports just requested users by default, so if you click to View all users in Keycloak admin console, you will see just those LDAP users, which were already authenticated/requested by Keycloak. If you want to sync all LDAP users into Keycloak database, you may configure and enable Sync, which is in @@ -160,7 +160,7 @@ Writing a User Federation Provider starts by implementing the UserFederationProvider and UserFederationProviderFactory interfaces. Please see the Javadoc and example - for complete details on on how to do this. Some important methods of note: + for complete details on how to do this. Some important methods of note: getUserByUsername() and getUserByEmail() require that you query your federated storage and if the user exists create and import the user into Keycloak storage. How much metadata you import is fully up to you. This import is done by invoking methods on the object returned KeycloakSession.userStorage() @@ -173,7 +173,7 @@ contain a file called org.keycloak.models.UserFederationProviderFactory within the META-INF/services directory of the JAR. This file is a list of fully qualified classnames of all implementations of UserFederationProviderFactory. - This is how Keycloak discovers which providers have been deployment. Place the JAR in the + This is how Keycloak discovers which providers have been deployed. Place the JAR in the keycloak WAR deployment in the WEB-INF/lib directory.