Skip to content

Commit 7fc171b

Browse files
committed
Document loginpage_links feature
1 parent e4bb90b commit 7fc171b

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

docs/simplesamlphp-idp-more.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,30 @@ IdP-initiated logout can be initiated by visiting the URL:
5656
`https://idp.example.org/simplesaml/saml2/idp/SingleLogoutService.php?ReturnTo=<URL to return to after logout>`
5757

5858
It will send a logout request to each SP, and afterwards return the user to the URL specified in the `ReturnTo` parameter. Bear in mind that IdPs might disallow redirecting to URLs other than those of their own for security reasons, so in order to get the redirection to work, it might be necessary to ask the IdP to whitelist the URL we are planning to redirect to.
59+
60+
Adding links to the login page
61+
------------------------------
62+
63+
If you want to add some helpful links to the login page, you can add
64+
the following to the `authsources.php` config of the authentication
65+
source you are using:
66+
67+
```php
68+
'example-userpass' => [
69+
...
70+
'core:loginpage_links' => [
71+
[
72+
'href' => 'https://example.com/reset',
73+
'text' => 'Forgot your password?',
74+
],
75+
[
76+
'href' => 'https://example.com/news',
77+
'text' => 'Latest news about us',
78+
],
79+
],
80+
...
81+
],
82+
```
83+
84+
The given text will also be translated via SimpleSAMLphp's translation
85+
system if translations are available in the messages catalog.

0 commit comments

Comments
 (0)