Skip to content

Document automatic IdP routing limitation (OKTA-1062349) #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brentschaus-okta wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document automatic IdP routing limitation (OKTA-1062349) #243

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ To see this library working in a sample, check out our [ASP.NET Samples](samples
> This library is currently GA. See [release status](#release-status) for more information.

* [Release status](#release-status)
* [Known limitations](#known-limitations)
* [Need help?](#need-help)
* [Getting started](#getting-started)
* [Usage guide](#usage-guide)
Expand All @@ -38,6 +39,33 @@ This library uses semantic versioning and follows Okta's [Library Version Policy

The latest release can always be found on the [releases page][github-releases].

## Known limitations

### Automatic IdP routing (IdP Discovery / Org2Org routing rules)

The embedded .NET SDK does **not** support automatically redirecting a user to a
third-party Identity Provider (IdP) based on an Org2Org routing rule (IdP Discovery) —
for example, routing a user to an external IdP based on their email domain without any
user interaction.

The supported pattern is a **manual IdP redirect**: call `GetIdentityProvidersAsync` to
retrieve the available IdP options and present them to the user as "Sign in with <IdP>"
buttons. When the user selects an option, redirect them to the returned `Href`.

```csharp
var idpResponse = await _idxClient.GetIdentityProvidersAsync(idxContext);

if (idpResponse.IdpOptions?.Count > 0)
{
// Present idpResponse.IdpOptions to the user as buttons, then redirect to the
// selected option's Href. The SDK does not evaluate routing rules to auto-select an IdP.
var idpRedirectUrl = idpResponse.IdpOptions.First().Href;
}
```

See the [ASP.NET sample](samples/samples-aspnet/embedded-auth-with-sdk) for a working
example of the manual IdP redirect flow.

## Need help?

If you run into problems using the SDK, you can
Expand Down