Skip to content

Commit 104aa87

Browse files
committed
Amend docs
Signed-off-by: Ivan Kanakarakis <[email protected]>
1 parent fe2100c commit 104aa87

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

doc/README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -636,9 +636,12 @@ To choose which backend (essentially choosing target provider) to use based on t
636636
Use the `DecideBackendByTargetIssuer` class which implements that special routing behavior. See the
637637
[example configuration](../example/plugins/microservices/target_based_routing.yaml.example).
638638
639-
If a Discovery Service have been used and the target entity id is selected by users,
640-
also use `DiscoToTargetIssuer` together with `DecideBackendByTargetIssuer`
641-
to get the expected result. See the [example configuration](../example/plugins/microservices/disco_to_target_issuer.yaml.example).
639+
#### Route to a specific backend based on the discovery service response
640+
641+
If a Discovery Service is in use and a target entity id is selected by users, you may want to use the
642+
`DiscoToTargetIssuer` class together with `DecideBackendByTargetIssuer` to be able to select a
643+
backend (essentially choosing target provider) based on the response from the discovery service.
644+
See the [example configuration](../example/plugins/microservices/disco_to_target_issuer.yaml.example).
642645
643646
#### Filter authentication requests to target SAML entities
644647
@@ -709,14 +712,15 @@ persistent NameID may also be obtained from attributes returned from the LDAP di
709712
LDAP microservice install the extra necessary dependencies with `pip install satosa[ldap]` and then see the
710713
[example config](../example/plugins/microservices/ldap_attribute_store.yaml.example).
711714
712-
#### Minimal support for IdP Hinting
715+
#### Support for IdP Hinting
713716
714-
It's possible to hint an IdP to SaToSa using `IdpHinting` microservice. See the
715-
[example configuration](../example/plugins/microservices/idp_hinting.yaml.example).
717+
It's possible to hint an IdP to SaToSa using the `IdpHinting` micro-service.
716718
717-
With this feature an SP can send an hint about the IdP to avoid the discovery
718-
service page to the users, using a url parameter. Example
719-
`https://[...]?[...]&idphint=https://that.idp.entity.id"`
719+
With this feature an SP can send a hint about the IdP that should be used, in order to skip the discovery service.
720+
The hint as a parameter in the query string of the request.
721+
The hint query parameter value must be the entityID of the IdP.
722+
The hint query parameter name is specified in the micro-service configuation.
723+
See the [example configuration](../example/plugins/microservices/idp_hinting.yaml.example).
720724
721725
### Custom plugins
722726

0 commit comments

Comments
 (0)