Skip to content

Commit

Permalink
refactor: add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Eisie96 committed Oct 20, 2023
1 parent fed56c7 commit 934784f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/concepts/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ With the ICM identity provider, for example, the user is then automatically logg

## Activate Identity Provider on specific paths

For specific use cases the PWA have to activate the identity provider for specific pwa url paths.
In future the PWA will have more cases which needs to activate the identity provider for specific pwa url paths.
This is the case when the PWA enters a `/punchout` route in order to automatically login a punchout user.
The behavior can be configured primarily by adding `activeOnPath` property for the IDENTITY_PROVIDER_IMPLEMENTOR.

Expand All @@ -115,7 +115,7 @@ The behavior can be configured primarily by adding `activeOnPath` property for t

This configuration would activate the specific identity provider, when the PWA initially routes to a specific url.

An another possibility is to use the `OVERRIDE_IDENTITY_PROVIDERS` environment variable within the nginx deployment.
Another possibility or the identity provider activation could be the usage of the `OVERRIDE_IDENTITY_PROVIDERS` environment variable within the nginx deployment.

```yaml
nginx:
Expand All @@ -126,7 +126,7 @@ nginx:
type: Punchout
```
The feature will like the `MULTI_CHANNEL` configuration add `identityProvider` parameter to generated PWA url, when the nginx retrieves a request with a certain domain and path.
Like the `MULTI_CHANNEL` configuration the feature will add the `identityProvider` parameter to the generated PWA url, when the nginx retrieves a request with a certain domain and path.
More details can be seen in [Further References](#further-references) below.

## Further References
Expand Down
3 changes: 3 additions & 0 deletions src/app/core/identity-provider/identity-provider.factory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ export class IdentityProviderFactory {
return this.config?.type;
}

/**
* notifies when correct identity provider is selected
*/
getInitialized$(): Observable<boolean> {
return this.initialized$.asObservable();
}
Expand Down

0 comments on commit 934784f

Please sign in to comment.