libre.sh/keycloak-scim
2
0
Fork 0
Code Issues 14 Pull requests Releases Packages Activity Actions 6

Merge pull request #22 from jenmalloy/use-variable-urls

Browse source 
added variables for external URLs
This commit is contained in:
Jen Malloy 2016-12-08 15:43:41 -05:00 committed by GitHub
commit e9cd71fd1f
6 changed files with 20 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
book-product.json
View file

@ -21,20 +21,20 @@
"images": "rhsso-images",
"adminguide": {
"name": "Server Administration Guide",
"link": "https://access.redhat.com/documentation/en/red-hat-single-sign-on/7.1-Beta/server-administration-guide/"
"link": "/single/server-administration-guide/"
},
"clientguide": {
"name": "Securing Applications and Services Guide",
"link": "https://access.redhat.com/documentation/en/red-hat-single-sign-on/7.1-Beta/securing-applications-and-services-guide/"
"link": "/single/securing-applications-and-services-guide/"
},
"installguide": {
"name": "Server Installation and Configuration Guide",
"link": "https://access.redhat.com/documentation/en/red-hat-single-sign-on/7.1-Beta/server-installation-and-configuration-guide/"
"link": "/single/server-installation-and-configuration-guide/"
},
"apidocs": {
"name": "API Documentation",
"link": "https://access.redhat.com/documentation/en/red-hat-single-sign-on/7.1-Beta/api-documentation/"
"link": "/single/api-documentation/"
}
}
}

10
topics/admin-rest-api.adoc
View file

@ -3,12 +3,12 @@
{{book.project.name}} comes with a fully functional Admin REST API with all features provided by the Admin Console.
To invoke the API you need to obtain an access token with the appropriate permissions. The required permissions are described in
{{book.adminguide.link}}[{{book.adminguide.name}}].
{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.adminguide.link}}[{{book.adminguide.name}}].
A token can be obtained by enabling authenticating to your application with {{book.project.name}}, see the
{{book.clientguide.link}}[{{book.clientguide.name}}]. You can also use direct access grant to obtain an access token.
A token can be obtained by enabling authenticating to your application with {{book.project.name}}; see the
{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.clientguide.link}}[{{book.clientguide.name}}]. You can also use direct access grant to obtain an access token.
Refer to {{book.apidocs.link}}[{{book.apidocs.name}}] for complete documentation.
For complete documentation see {{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.apidocs.link}}[{{book.apidocs.name}}].
=== Example using CURL
@ -60,5 +60,5 @@ Keycloak keycloak = Keycloak.getInstance(
RealmRepresentation realm = keycloak.realm("master").toRepresentation();
----
Complete Javadoc for the admin client is available at {{book.apidocs.link}}[{{book.apidocs.name}}].
Complete Javadoc for the admin client is available at {{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.apidocs.link}}[{{book.apidocs.name}}].
{% endif %}

4
topics/auth-spi.adoc
View file

@ -755,7 +755,7 @@ In other words, add your custom authenticator after the "Send Reset Email" authe
First Broker Login flow is used during first login with some identity provider.
Term `First Login` means that there is not yet existing {{book.project.name}} account linked with the particular authenticated identity provider account.
More details about this flow are in the `Identity Brokering` chapter in link:{{book.adminguide.link}}[{{book.adminguide.name}}] .
For more details about this flow see the `Identity Brokering` chapter in link:{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.adminguide.link}}[{{book.adminguide.name}}] .
[[_client_authentication]]
=== Authentication of clients
@ -766,7 +766,7 @@ to the {{book.project.name}} server (like the request for exchange code to acces
But the client authentication can be also used directly by you during `Direct Access grants` (represented by OAuth2 `Resource Owner Password Credentials Flow`)
or during `Service account` authentication (represented by OAuth2 `Client Credentials Flow`).
See link:{{book.clientguide.link}}[{{book.clientguide.name}}] for more details about {{book.project.name}} adapter and OAuth2 flows.
For more details about {{book.project.name}} adapter and OAuth2 flows see link:{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.clientguide.link}}[{{book.clientguide.name}}].
==== Default implementations

2
topics/providers.adoc
View file

@ -88,7 +88,7 @@ org.acme.provider.MyEventListenerProviderFactory
----
You can configure your provider through `standalone.xml`, `standalone-ha.xml`, or `domain.xml`.
See the link:{{book.installguide.link}}[{{book.installguide.name}}] for more details on
See the link:{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.installguide.link}}[{{book.installguide.name}}] for more details on
where the `standalone.xml`, `standalone-ha.xml`, or `domain.xml` file lives.
For example by adding the following to `standalone.xml`:

14
topics/themes.adoc
View file

@ -19,14 +19,13 @@ A theme can provide one or more types to customize different aspects of {{book.p
=== Configure Theme
All theme types, except welcome, are configured through the `Admin Console`. To change the theme used for a realm open the `Admin Console`, select
your realm from the drop-down box in the top left corner. Under `Realm Settings` click on `Themes`.
your realm from the drop-down box in the top left corner. Under `Realm Settings` click `Themes`.
NOTE: To set the theme for the `master` admin console you need to set the admin console theme for the `master` realm. To see the changes to the admin console
refresh the page.
To change the welcome theme you need to edit `standalone.xml`, `standalone-ha.xml`, or `domain.xml`.
See the link:{{book.installguide.link}}[{{book.installguide.name}}] for more details on
where the `standalone.xml`, `standalone-ha.xml`, or `domain.xml` file lives.
For more information on where the `standalone.xml`, `standalone-ha.xml`, or `domain.xml` file resides see the link:{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.installguide.link}}[{{book.installguide.name}}].
Add `welcomeTheme` to the theme element, for example:
@ -209,14 +208,14 @@ of the realm.
==== Internationalization
{{book.project.name}} supports internationalization. To enable internationalization for a realm see {{book.adminguide.link}}[{{book.adminguide.name}}]. This
section will describe how you can add your own language.
{{book.project.name}} supports internationalization. To enable internationalization for a realm see {{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.adminguide.link}}[{{book.adminguide.name}}]. This
section describes how you can add your own language.
To add a new language create the file `<THEME TYPE>/messages/messages_<LOCALE>` in the directory of your theme. Then add it to the `locales` property in
`<THEME TYPE>/theme.properties`. For a language to be available to users the realms `login`, `account` and `email` theme has to support the language, so you
need to add your language for those theme types.
For example to add Norwegian translations to the `mytheme` theme create the file `themes/mytheme/login/messages/messages_no.properties` with the
For example, to add Norwegian translations to the `mytheme` theme create the file `themes/mytheme/login/messages/messages_no.properties` with the
following content:
[source]
@ -356,8 +355,7 @@ To manually create the module create the directory `modules/org/keycloak/example
----
You also need to register the module with {{book.project.name}}. This is done by editing `standalone.xml`, `standalone-ha.xml`, or `domain.xml`.
See the link:{{book.installguide.link}}[{{book.installguide.name}}] for more details on
where the `standalone.xml`, `standalone-ha.xml`, or `domain.xml` file lives.
For more information on where the `standalone.xml`, `standalone-ha.xml`, or `domain.xml` file resides see the link:{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.installguide.link}}[{{book.installguide.name}}].
Then find the `theme` tag under `keycloak-server` subsystem and add the module to `theme/modules/module`. For example:

5
topics/user-storage/simple-example.adoc
View file

@ -248,10 +248,9 @@ We then load the `properties` field with the username and password combinations
The `Config.Scope` parameter is factory configuration that can be set up
within `standalone.xml`, `standalone-ha.xml`, or `domain.xml`.
See the link:{{book.installguide.link}}[{{book.installguide.name}}] for more details on
where the `standalone.xml`, `standalone-ha.xml`, or `domain.xml` file lives.
For more information on where the `standalone.xml`, `standalone-ha.xml`, or `domain.xml` file resides see the link:{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.installguide.link}}[{{book.installguide.name}}].
For example by adding the following to `standalone.xml`:
For example, by adding the following to `standalone.xml`:
[source,xml]
----