libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions

Merge pull request #986 from pedroigor/master

Browse source 
[KEYCLOAK-994] - Identity broker documentation.
This commit is contained in:
Pedro Igor 2015-02-20 23:09:52 -02:00
commit 463e33e232
6 changed files with 1051 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
distribution/examples-docs-zip/build.xml
View file

@ -34,6 +34,14 @@
<exclude name="**/subsystem-config.xml"/>
</fileset>
</copy>
<copy todir="target/examples/broker" overwrite="true">
<fileset dir="../../examples/broker">
<exclude name="**/target/**"/>
<exclude name="**/*.iml"/>
<exclude name="**/*.unconfigured"/>
<exclude name="**/subsystem-config.xml"/>
</fileset>
</copy>
<copy todir="target/examples/js-console" overwrite="true">
<fileset dir="../../examples/js-console">
<exclude name="**/target/**"/>

23
docbook/reference/en/en-US/master.xml
View file

@ -21,12 +21,7 @@
<!ENTITY Logout SYSTEM "modules/logout.xml">
<!ENTITY SAML SYSTEM "modules/saml.xml">
<!ENTITY JAAS SYSTEM "modules/jaas.xml">
<!ENTITY SocialConfig SYSTEM "modules/social-config.xml">
<!ENTITY SocialFacebook SYSTEM "modules/social-facebook.xml">
<!ENTITY SocialGitHub SYSTEM "modules/social-github.xml">
<!ENTITY SocialGoogle SYSTEM "modules/social-google.xml">
<!ENTITY SocialTwitter SYSTEM "modules/social-twitter.xml">
<!ENTITY SocialProviderSPI SYSTEM "modules/social-spi.xml">
<!ENTITY IdentityBroker SYSTEM "modules/identity-broker.xml">
<!ENTITY Themes SYSTEM "modules/themes.xml">
<!ENTITY Migration SYSTEM "modules/MigrationFromOlderVersions.xml">
<!ENTITY Email SYSTEM "modules/email.xml">
@ -105,21 +100,7 @@ This one is short
&JAAS;
</chapter>
<chapter>
<title>Social</title>
<para>
Keycloak makes it easy to let users log in to your application using an existing account with a social network.
Currently Facebook, Google and Twitter is supported with more planned for the future. There's also a Social
Provider SPI that makes it relatively simple to add additional social networks.
</para>
&SocialConfig;
&SocialFacebook;
&SocialGitHub;
&SocialGoogle;
&SocialTwitter;
&SocialProviderSPI;
</chapter>
&IdentityBroker;
&Themes;
<chapter>

1035
docbook/reference/en/en-US/modules/identity-broker.xml Executable file
View file

File diff suppressed because it is too large Load diff

6
docbook/reference/en/en-US/modules/social-github.xml
View file

@ -2,13 +2,13 @@
<title>GitHub</title>
<para>
To enable login with GitHub you first have to create an application in
<ulink url="https://github.com/settings/applications">GitHub Settings</ulink>. Then you need to copy
<link xlink:href="https://github.com/settings/applications">GitHub Settings</link>. Then you need to copy
the client id and secret into the Keycloak Admin Console.
</para>
<orderedlist>
<listitem>
<para>
Log in to <ulink url="https://github.com/settings/applications">GitHub Settings</ulink>. Click the
Log in to <link xlink:href="https://github.com/settings/applications">GitHub Settings</link>. Click the
<literal>Register new application</literal> button. Use any value for <literal>Application name</literal>,
<literal>Homepage URL</literal> and <literal>Application Description</literal> you want. In <literal>Authorization callback URL</literal>
enter the <link linkend="social-callbackurl">social callback url</link> for your realm. Click the
@ -18,7 +18,7 @@
<listitem>
<para>
Copy <literal>Client ID</literal> and <literal>Client secret</literal> from the
<ulink url="https://github.com/settings/applications">GitHub Settings</ulink> into the settings
<link xlink:href="https://github.com/settings/applications">GitHub Settings</link> into the settings
page in the Keycloak Admin Console as the <literal>Key</literal> and <literal>Secret</literal>. Then click
<literal>Save</literal> in the Keycloak Admin Console to enable login with GitHub.
</para>

6
docbook/reference/en/en-US/modules/social-twitter.xml
View file

@ -2,13 +2,13 @@
<title>Twitter</title>
<para>
To enable login with Twtter you first have to create an application in the
<ulink url="https://dev.twitter.com/apps">Twitter Developer Console</ulink>. Then you need to copy
<link xlink:href="https://dev.twitter.com/apps">Twitter Developer Console</link>. Then you need to copy
the consumer key and secret into the Keycloak Admin Console.
</para>
<orderedlist>
<listitem>
<para>
Log in to the <ulink url="https://dev.twitter.com/apps">Twitter Developer Console</ulink>. Click the
Log in to the <link xlink:href="https://dev.twitter.com/apps">Twitter Developer Console</link>. Click the
<literal>Create a new application</literal> button. Use any value for <literal>Name</literal>,
<literal>Description</literal> and <literal>Website</literal> you want. Insert the social callback url
in <literal>Callback URL</literal>. Then click <literal>Create your Twitter application</literal>.
@ -23,7 +23,7 @@
<listitem>
<para>
Now click <literal>API Keys</literal> tab. Copy <literal>API key</literal> and <literal>API secret</literal> from the
<ulink url="https://dev.twitter.com/apps">Twitter Developer Console</ulink> into the settings
<link xlink:href="https://dev.twitter.com/apps">Twitter Developer Console</link> into the settings
page in the Keycloak Admin Console as the <literal>Key</literal> and <literal>Secret</literal>. Then click
<literal>Save</literal> in the Keycloak Admin Console to enable login with Twitter.
</para>

BIN
docbook/reference/en/images/identity_broker_flow.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 21 KiB