Document the embedded sign-in form - #15
Merged
Merged
Conversation
Adds an "Embedded sign-in" section between Authentication and Identification: the widget runs the authentication in an iframe on the integrator's own page instead of redirecting, using the same service, credentials, scopes and ID token — only the start of the flow differs. Covers when NOT to use it (public/PKCE clients cannot: creating a session needs the client secret), enabling it and allowlisting origins in eeID manager, the three API calls with parameters and samples, the widget element with its attributes and events, redeeming the single-use result token, return_url for the methods that must leave the frame, theming, the error table, rate limits and the test environment. Two things integrators cannot guess are called out explicitly: the code never reaches the browser (their backend redeems a single-use token for it), and they must take the iframe down on eeid:success or a completed sign-in looks hung. Links the PHP example at github.com/internetee/eeid_php_embedded_demo. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GP9ZnyKyjjFfBmv3evRGV3
Docs PreviewPreview deployed successfully. Access it here: https://internetee.github.io/eeID-DOC/previews/pr-15/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds an "Embedded sign-in" section between Authentication and Identification: the widget runs the authentication in an iframe on the integrator's own page instead of redirecting, using the same service, credentials, scopes and ID token — only the start of the flow differs.
Covers when NOT to use it (public/PKCE clients cannot: creating a session needs the client secret), enabling it and allowlisting origins in eeID manager, the three API calls with parameters and samples, the widget element with its attributes and events, redeeming the single-use result token, return_url for the methods that must leave the frame, theming, the error table, rate limits and the test environment.
Two things integrators cannot guess are called out explicitly: the code never reaches the browser (their backend redeems a single-use token for it), and they must take the iframe down on eeid:success or a completed sign-in looks hung.
Links the PHP example at github.com/internetee/eeid_php_embedded_demo.