From 19090083492fe11a7c0463a10c0b4d9996eb3cf4 Mon Sep 17 00:00:00 2001 From: Jacob Christiansen <jach@wayf.dk> Date: Fri, 6 Nov 2009 11:09:08 +0000 Subject: [PATCH] Updated documentation for consent and consentAdmin modules. git-svn-id: https://simplesamlphp.googlecode.com/svn/trunk@1979 44740490-163a-0410-bde0-09ae8108e29a --- modules/consent/docs/consent.txt | 16 ++++++++++++++++ modules/consentAdmin/docs/consentAdmin.txt | 6 ++++-- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/modules/consent/docs/consent.txt b/modules/consent/docs/consent.txt index d54ba710f..c3dd66730 100644 --- a/modules/consent/docs/consent.txt +++ b/modules/consent/docs/consent.txt @@ -73,3 +73,19 @@ Example config using PostgreSQL database: 'checked' => TRUE ), +Disabling consent +----------------- + +It is possible to disable consent for a given service. You can add an option +in the matadata og the IdP, that wil disable consent for det given service. +Add 'consent.disable' array option and enter the entityids of the services, +that you do not want consent for. + +Example: + + 'consent.disable' => array( + 'sp.example.com', + 'sp2.example.com', + ... + ), + diff --git a/modules/consentAdmin/docs/consentAdmin.txt b/modules/consentAdmin/docs/consentAdmin.txt index 20e3d2a6d..a4e176a45 100644 --- a/modules/consentAdmin/docs/consentAdmin.txt +++ b/modules/consentAdmin/docs/consentAdmin.txt @@ -46,7 +46,7 @@ module correctly, you need to set the configuration 'attributes.hash' according to the value of 'includeValues' configuration in the consent module. -You should also set the 'relaystate' configuration in order to pass on your +You should also set the 'returnURL' configuration in order to pass on your users when the press the 'Logout' link. What does consentAdmin do @@ -59,6 +59,8 @@ whether the user has given consent to the given service. By clicking the released to the service, when the user is accessing that service. consentAdmin are running the processing filters that have been defined for each service. +ConsentAdmin will not show services that consent has been disabled for in +the consent module. Processing filters ------------------ @@ -68,6 +70,6 @@ no filter is allowed to make userinteraction. It is up to the developers of the filters to respect the isPassive request. The prefered thing to do is to make your setup so that only filters that -modify attributes is run. Othervise it is recommended that tha developers of +modify attributes is run. Othervise it is recommended that developers of filters to throw a 'NoPassive' exception, if the filter can not run without userinteraction. -- GitLab