summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Dauvergne <bdauvergne@entrouvert.com>2010-03-27 17:39:57 +0000
committerBenjamin Dauvergne <bdauvergne@entrouvert.com>2010-03-27 17:39:57 +0000
commitaea8e65e8212afe80548ca39d3ec3de71f2b1406 (patch)
treee6e128cb8954a3af6b27815757bac0621b27e7f0
parentf09332e9d6f8ab1f4297a8fe8cef2fb42f7d6137 (diff)
downloadlasso-aea8e65e8212afe80548ca39d3ec3de71f2b1406.tar.gz
lasso-aea8e65e8212afe80548ca39d3ec3de71f2b1406.tar.xz
lasso-aea8e65e8212afe80548ca39d3ec3de71f2b1406.zip
update lasso_login_accept_sso documentation
-rw-r--r--lasso/id-ff/login.c32
1 files changed, 23 insertions, 9 deletions
diff --git a/lasso/id-ff/login.c b/lasso/id-ff/login.c
index a154b90d..8cdc26fe 100644
--- a/lasso/id-ff/login.c
+++ b/lasso/id-ff/login.c
@@ -714,20 +714,34 @@ cleanup:
* lasso_login_accept_sso:
* @login: a #LassoLogin
*
- * Gets the assertion of the response and adds it into the session.
+ * Gets the assertion of the response and adds it to the #LassoSession object.
* Builds a federation with the 2 name identifiers of the assertion
* and adds it into the identity.
* If the session or the identity are NULL, they are created.
*
* Return value: 0 on success; or
- * LASSO_PARAM_ERROR_BAD_TYPE_OR_NULL_OBJ if login is not a #LassoLogin object,
- * LASSO_PROFILE_ERROR_MISSING_RESPONSE if no response is present in the login profile object --
- * usually because no call to lasso_login_process_authn_response_msg was donne --,
- * LASSO_PROFILE_ERROR_MISSING_ASSERTION if the response does not contain an assertion,
- * LASSO_PROFILE_ERROR_NAME_IDENTIFIER_NOT_FOUND if the assertion does not contain a NameID element,
- * LASSO_PROFILE_ERROR_MISSING_NAME_IDENTIFIER idem,
- * LASSO_LOGIN_ERROR_ASSERTION_REPLAY if the assertion has already been used.
- *
+ * <itemizedlist>
+ * <listitem><para>
+ * #LASSO_PARAM_ERROR_BAD_TYPE_OR_NULL_OBJ if login is not a #LassoLogin object,
+ * </para></listitem>
+ * <listitem><para>
+ * #LASSO_PROFILE_ERROR_MISSING_RESPONSE if no response is present in the login profile object&nbsp;—
+ * usually because no call to lasso_login_process_authn_response_msg was donne&nbsp;—,
+ * </para></listitem>
+ * <listitem><para>
+ * #LASSO_PROFILE_ERROR_MISSING_ASSERTION if the response does not contain an assertion,
+ * </para></listitem>
+ * <listitem><para>
+ * #LASSO_PROFILE_ERROR_NAME_IDENTIFIER_NOT_FOUND if the assertion does not contain a NameID element,
+ * </para></listitem>
+ * <listitem><para>
+ * #LASSO_PROFILE_ERROR_MISSING_NAME_IDENTIFIER same as
+ * #LASSO_PROFILE_ERROR_NAME_IDENTIFIER_NOT_FOUND,
+ * </para></listitem>
+ * <listitem><para>
+ * #LASSO_LOGIN_ERROR_ASSERTION_REPLAY if the assertion has already been used.
+ * </para></listitem>
+ * <itemizedlist>
**/
gint
lasso_login_accept_sso(LassoLogin *login)