Revision: 2009
Author: olavmrk
Date: Thu Nov 26 01:18:04 2009
Log: docs: Update documentation for SP login parameters.
http://code.google.com/p/simplesamlphp/source/detail?r=2009
Modified:
/trunk/docs/simplesamlphp-sp-api.txt
/trunk/modules/saml/docs/sp.txt
=======================================
--- /trunk/docs/simplesamlphp-sp-api.txt Tue Oct 27 05:02:34 2009
+++ /trunk/docs/simplesamlphp-sp-api.txt Thu Nov 26 01:18:04 2009
@@ -40,7 +40,7 @@
`requireAuth`
-------------
- void requireAuth(array $options = array())
+ void requireAuth(array $params = array())
Make sure that the user is authenticated.
This function will only return if the user is authenticated.
@@ -48,18 +48,9 @@
### Parameters
-`$options` is an associative array with named parameters for this function.
-The following named parameters are supported:
-
-`KeepPost` (`bool`)
-
-: If set to `TRUE`, the current POST data will be submittet again after
authentication.
- The default is `TRUE`.
-
-`ReturnTo` (`string`)
-
-: The URL the user should be returned to after authentication.
- The default is to return the user to the current page.
+`$params` is an associative array with named parameters for this function.
+See the documentation for the `login`-function for a description of the
parameters.
+
### Example 1
@@ -79,6 +70,43 @@
print("Hello, authenticated user!");
+`login`
+-------------
+
+ void login(array $params = array())
+
+Start a login operation.
+This function will always start a new authentication process.
+
+### Parameters
+
+The following global parameters are supported:
+
+`ErrorURL` (`string`)
+
+: An URL to a page which will receive errors that may occur during
authentication.
+
+`KeepPost` (`bool`)
+
+: If set to `TRUE`, the current POST data will be submitted again after
authentication.
+ The default is `TRUE`.
+
+`ReturnTo` (`string`)
+
+: The URL the user should be returned to after authentication.
+ The default is to return the user to the current page.
+
+The
[`saml:SP`](https://rnd.feide.no/content/saml-service-provider-configuration-reference)
authentication source also defines some parameters.
+
+
+### Example
+
+ # Send a passive authentication request.
+ $auth->login(array(
+ 'saml:IsPassive' => TRUE,
+ 'ErrorURL' => 'https://.../error_handler.php',
+ ));
+
`logout`
--------
=======================================
--- /trunk/modules/saml/docs/sp.txt Wed Nov 18 00:15:40 2009
+++ /trunk/modules/saml/docs/sp.txt Thu Nov 26 01:18:04 2009
@@ -9,11 +9,12 @@
The metadata for your SP will be available from the federation page on
your simpleSAMLphp installation.
-Options
+
+Parameters
-------
-These are options that can be used at runtime to control the
authentication.
-All these options override the equivalent option from the configuration.
+These are parameters that can be used at runtime to control the
authentication.
+All these parameters override the equivalent option from the configuration.
`saml:AuthnContextClassRef`
: The AuthnContextClassRef that will be sent in the login request.
@@ -27,10 +28,10 @@
: *Note*: SAML 2 specific.
`saml:idp`
-: The entity ID this SP should connect to.
+: The entity ID of the IdP we should send an authentication request to.
`saml:IsPassive`
-: IsPassive allows you to enable passive authentication by default for
this SP.
+: Send a passive authentication request.
: *Note*: SAML 2 specific.
@@ -82,10 +83,12 @@
),
-### Requesting passive authentication
-
-$auth = new SimpleSAML_Auth_Simple('default-sp');
-$auth->login(array('saml:IsPassive' => TRUE));
+### Requesting a specific authentication method.
+
+ $auth = new SimpleSAML_Auth_Simple('default-sp');
+ $auth->login(array(
+ 'saml:AuthnContextClassRef'
=> 'urn:oasis:names:tc:SAML:2.0:ac:classes:Password',
+ ));
Options
--
You received this message because you are subscribed to the Google Groups
"simpleSAMLphp commits" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/simplesamlphp-commits?hl=en.
