mirror/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2025-12-16 20:15:46 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fixing link to external docs

Browse Source 
Closes #33991

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
This commit is contained in:
Alexander Schwartz
2024-10-17 12:03:47 +02:00
committed by Pedro Igor
parent 9092be9640
commit 3111148fe7
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/documentation/securing_apps/topics/oidc/javascript-adapter.adoc
View File

@@ -44,9 +44,9 @@ try {
} }
---- ----
To authenticate, you call the `login` function. Two options exist to make the adapter automatically authenticate. You can pass `login-required` or `check-sso` to the `init()` function. To authenticate, you call the `login` function. Two options exist to make the adapter automatically authenticate. You can pass `login-required` or `check-sso` to the `init()` function.
* `login-required` authenticates the client if the user is logged in to {project_name} or displays the login page if the user is not logged in. * `login-required` authenticates the client if the user is logged in to {project_name} or displays the login page if the user is not logged in.
* `check-sso` only authenticates the client if the user is already logged in. If the user is not logged in, the browser is redirected back to the application and remains unauthenticated. * `check-sso` only authenticates the client if the user is already logged in. If the user is not logged in, the browser is redirected back to the application and remains unauthenticated.
You can configure a _silent_ `check-sso` option. With this feature enabled, your browser will not perform a full redirect to the {project_name} server and back to your application, but this action will be performed in a hidden iframe. Therefore, your application resources are only loaded and parsed once by the browser, namely when the application is initialized and not again after the redirect back from {project_name} to your application. This approach is particularly useful in case of SPAs (Single Page Applications). You can configure a _silent_ `check-sso` option. With this feature enabled, your browser will not perform a full redirect to the {project_name} server and back to your application, but this action will be performed in a hidden iframe. Therefore, your application resources are only loaded and parsed once by the browser, namely when the application is initialized and not again after the redirect back from {project_name} to your application. This approach is particularly useful in case of SPAs (Single Page Applications).
@@ -206,9 +206,9 @@ This adapter requires two additional plugins:
The technical details for linking to an app differ on each platform and special setup is needed. The technical details for linking to an app differ on each platform and special setup is needed.
Please refer to the Android and iOS sections of the https://github.com/e-imaxina/cordova-plugin-deeplinks/blob/master/README.md[deeplinks plugin documentation] for further instructions. Please refer to the Android and iOS sections of the https://github.com/e-imaxina/cordova-plugin-deeplinks/blob/master/README.md[deeplinks plugin documentation] for further instructions.
Different kinds of links exist for opening apps: Different kinds of links exist for opening apps:
* custom schemes, such as `myapp://login` or `android-app://com.example.myapp/https/example.com/login` * custom schemes, such as `myapp://login` or `android-app://com.example.myapp/https/example.com/login`
* https://developer.apple.com/ios/universal-links/[Universal Links (iOS)]) / https://developer.android.com/training/app-links/deep-linking[Deep Links (Android)]. * https://developer.apple.com/documentation/xcode/allowing-apps-and-websites-to-link-to-your-content/[Universal Links (iOS)] / https://developer.android.com/training/app-links/deep-linking[Deep Links (Android)].
While the former are easier to set up and tend to work more reliably, the latter offer extra security because they are unique and only the owner of a domain can register them. Custom-URLs are deprecated on iOS. For best reliability, we recommend that you use universal links combined with a fallback site that uses a custom-url link. While the former are easier to set up and tend to work more reliably, the latter offer extra security because they are unique and only the owner of a domain can register them. Custom-URLs are deprecated on iOS. For best reliability, we recommend that you use universal links combined with a fallback site that uses a custom-url link.
Furthermore, we recommend the following steps to improve compatibility with the adapter: Furthermore, we recommend the following steps to improve compatibility with the adapter:
@@ -487,8 +487,8 @@ Returns true if the token has less than minValidity seconds left before it expir
*updateToken(minValidity)* *updateToken(minValidity)*
If the token expires within minValidity seconds (minValidity is optional, if not specified 5 is used) the token is refreshed. If the token expires within minValidity seconds (minValidity is optional, if not specified 5 is used) the token is refreshed.
If -1 is passed as the minValidity, the token will be forcibly refreshed. If -1 is passed as the minValidity, the token will be forcibly refreshed.
If the session status iframe is enabled, the session status is also checked. If the session status iframe is enabled, the session status is also checked.
Returns a promise that resolves with a boolean indicating whether or not the token has been refreshed. Returns a promise that resolves with a boolean indicating whether or not the token has been refreshed.