Commit graph

57 commits

Author SHA1 Message Date
Wojciech Trocki
96bab33db1
fix: add information about npm packagage (#1189)
I recieved feedback from customer/users that keycloak client side is widely undocumented, which was surprising.
After checking I found out that in fact for users that use npm there is no documentation provided:

https://www.npmjs.com/package/keycloak-js

This is very rare to see in NPM for package that have such large number of downloads. 
Additionally official docs doesn't mention NPM at all and recommend using js package from server (which is not be best advice if you do CDN's etc.).
Additionally some old bower repo is still 3th result in google and since it has some docs people using it:
https://github.com/keycloak/keycloak-js-bower - worth to remove this as well. 
Added simple note in the docs so hopefully google will position this documentation
2021-11-10 09:52:54 +01:00
Luigi Bertaco Cristofolini
6ec35d7dd0
Add example for UPDATE_PASSWORD login action (#1243) 2021-11-10 09:45:56 +01:00
Stu Tomlinson
47045aedcc
Minor JavaScript Adapter Reference wording cleanup (#1154) 2021-11-10 09:41:47 +01:00
Michal Hajas
8436c1866b KEYCLOAK-16455 Update JS adapter init method reference with messageReceiveTimeout 2021-06-23 09:00:34 +02:00
Hynek Mlnarik
b572fcff07 KEYCLOAK-18301 Fix broken links 2021-05-31 08:59:58 +02:00
Manuel Rauber
c8109152a9 KEYCLOAK-17684: fix definition of createAccountUrl parameter 2021-04-28 09:02:01 +02:00
Andy Munro
e18ea48b26 KEYCLOAK-16929 Adding conscious language preface of the release notes 2021-03-02 09:34:57 +01:00
Niko Köbler
f9e5d78a56 KEYCLOAK-15158 adjust basic example of Keycloak JS adapter usage
As the JS adapter has evolved, it now tries to add an iframe element to the document body during initialization.
When used like in the basic example as before, there will be an JS error, as the document body is not yet available.
So we've to wait until the document is loaded, thus the initialization is put in a function and the function will be called upon body.onload()
2020-10-29 09:53:55 +01:00
Stian Thorgersen
39ad765fc9 Update javascript-adapter.adoc 2020-09-17 23:10:46 -07:00
Jon Koops
1652f55997 KEYCLOAK-14496 Document the ability to pass custom adapters into the JavaScript client 2020-07-01 19:27:02 -03:00
vmuzikar
f977559a16 KEYCLOAK-14104 Update documentation about silent check-sso to reflect 3rd party cookie blocking 2020-06-30 17:14:16 -03:00
stianst
3a2312f2c9 KEYCLOAK-9346 Docs for removal of JS promiseType 2020-03-04 08:53:31 +01:00
Greg. A
a14d34adcc highlighting some values for parameters 2020-02-14 10:02:39 +01:00
mhajas
33d554c149 KEYCLOAK-12125 Update docs regarding SameSite changes 2020-01-31 13:05:28 +01:00
Etienne
39f846aecb Update javascript-adapter.adoc
The `pkceMethod` option has to be configured in the `init` method and not the `constructor` (see https://github.com/keycloak/keycloak/blob/master/adapters/oidc/js/src/main/resources/keycloak.js#L160)
2020-01-07 08:31:51 +01:00
JannesD
f3b2913ad3 🎨 fixed inconsinstent example code indentations (#749)
Some of the code examples used 2 spaces, and some were wrongly indented. This PR fixes the inconsistent JavaScript indentation to 4 spaces, and ensures that opening and closing brackets/braces are placed on the same indentation
2019-10-31 12:43:43 +01:00
Jon Koops
cd7309ddaf [KEYCLOAK-11436] Update JavaScript adapter documentation to prefer native promises 2019-10-30 15:36:27 +01:00
Rob Winch
77d4447d18 Improve JS Adapter Documentation Admin Labels
The documentation currently does not use the same wording as the administrative UI. This makes finding the
correct setting more difficult. Additionally, the documentation does not surround the field names in tick
marks as it does in other places. This makes it less obvious what configuration needs to be done.

This commit adjusts the wording to match the administrative UI. It also ensures the field names are enclosed in tick marks.
2019-10-30 15:34:03 +01:00
Jon Koops
ac2ee48ff6 [KEYCLOAK-11193] Add new enableLogging option to JS adapter 2019-09-24 10:31:36 -03:00
Jon Koops
d4403d3e5e KEYCLOAK-11196 Document the useNonce option for JS adapter 2019-09-18 11:29:19 +02:00
Bruno Oliveira da Silva
d1014006d4 Fix sentence for KEYCLOAK-10734 based on feedback from #716
Co-authored-by: Andy Munro <amunro@redhat.com>
2019-09-02 08:02:12 -03:00
Niko Köbler
b1f4eb1462 KEYCLOAK-10734 Let the check-sso feature do the check in hidden iframe 2019-08-29 11:52:25 -03:00
Thomas Darimont
4d3ef66c86 KEYCLOAK-1033 Document PKCE configuration for JavaScript Adapter 2019-05-29 15:40:37 +02:00
Kohei Tamura
bc991b0cd8 Fix typos and improve document format 2019-04-29 15:03:58 +01:00
Kohei Tamura
da3e482fbb Fix a typo 2019-03-12 08:23:19 +01:00
Matthew Helmke
2c2c7f7b50 Revert "fixed Wildfly mentions and faulty links with underscores"
This reverts commit 1ecbc1ba14075203af437295927699adf84cc428.
2019-02-20 11:51:28 +01:00
Matthew Helmke
a8cdbc3ca3 fixed Wildfly mentions and faulty links with underscores 2019-02-20 11:51:28 +01:00
任暁棟
cdf9c4dbf3 Update javascript-adapter.adoc
change hybird to hybrid
2018-12-12 06:04:47 -06:00
Geoffrey Cleaves
da8ce0026e JS adapter promises have changed
It appears that instead of `.then` and `.catch` you now use `.success` and `.error`. I've updated the examples accordingly.
2018-11-19 08:40:16 -06:00
stianst
8529a624dd KEYCLOAK-7920 Documentation for change to native promise in JS adapter 2018-10-10 21:00:30 +02:00
Geoffrey Cleaves
ff95d3c7b0 Fixing a typo
was: alert(JSON.stringify(test, null, "  "));
now: alert(JSON.stringify(profile, null, "  "));
2018-10-08 21:56:29 +02:00
Johannes Knutsen
57bae71a75 Update http://openid.net to https://openid.net 2018-09-12 07:07:33 -05:00
mposolda
8ae19e5f78 KEYCLOAK-7437 Support for prompt=consent 2018-08-29 15:42:16 +02:00
Gregor Tudan
d98e0a25b5 KEYCLOAK-2606: set an explicit anchor for the cordova chapter 2018-07-18 10:52:19 +02:00
Gregor Tudan
63d2e54018 remove anchor links to the deeplinks-plugin 2018-07-18 10:52:19 +02:00
Gregor Tudan
d3a733f947 KEYCLOAK-2606: fix links 2018-07-18 10:52:19 +02:00
Gregor Tudan
bb7a5f5f22 KEYCLOAK-2606: Added fixes suggested by matthewhelmke 2018-07-18 10:52:19 +02:00
Gregor Tudan
044afd3e62 KEYCLOAK-2606: add links to the example cordova apps 2018-07-18 10:52:19 +02:00
Gregor Tudan
bf29410b6b KEYCLOAK-2606: document the different cordova modes of the javascript adapter 2018-07-18 10:52:19 +02:00
Lorent Lempereur
e3da92cc24 Javascript Adapter - Documentation about login options 'cordovaOptions' (#395) 2018-06-11 08:24:41 +02:00
Marek Posolda
099a71f981
KEYCLOAK-7075 Client scopes documentation (#389) 2018-06-08 15:39:15 +02:00
Kohei Tamura
911336913b Fix typos and improve readability (#381) 2018-05-29 10:02:18 +02:00
Alastair Hole
b44cfa64e8 "Its" possessive pronoun (#362) 2018-05-29 10:00:44 +02:00
ssilvert@win.redhat.com
cef17cc82e KEYCLOAK-7196: Add kcLocale to login Options 2018-04-23 10:00:55 -04:00
Wojciech Trocki
5ed85df376 Add adapter option to keycloak.js (#359)
* Add adapter option to keycloak.js

Adding documentation for adapter option that was exposed in https://github.com/keycloak/keycloak/pull/5067

* Apply language fixes
2018-04-20 09:18:43 +02:00
k-tamura
bf74b61e8b Fix incorrect source format 2018-02-08 23:30:35 +01:00
Ray DeCampo
bc4d894fcd KEYCLOAK-5578: Keycloak JS adapter returns native Promise instances when available.
Promise instances are adorned with success() and error() functions to retain backwards compatibility.
2018-01-25 20:42:39 +01:00
tspringr
08b96a693a Fix: Incorrect number of closing parenthesis (#219) 2017-11-08 08:56:26 +01:00
Jonathan Alvarsson
11d3fc1a03 Added missing } (#218) 2017-10-19 13:39:27 +02:00
Stian Thorgersen
44c6a3ca64 Convert documentation to AsciiDoctor 2017-08-28 20:10:09 +02:00