diff options
| author | Benjamin Dauvergne <bdauvergne@entrouvert.com> | 2010-03-27 17:40:00 +0000 |
|---|---|---|
| committer | Benjamin Dauvergne <bdauvergne@entrouvert.com> | 2010-03-27 17:40:00 +0000 |
| commit | 9aa68aa4efb6d050e42bd70f8e121f759d464173 (patch) | |
| tree | ce0a001beb21f189ce4e51e608a31a9748653c19 | |
| parent | 938d84e0ea2f2828f95d8b3408afb9515c16a184 (diff) | |
| download | lasso-9aa68aa4efb6d050e42bd70f8e121f759d464173.tar.gz lasso-9aa68aa4efb6d050e42bd70f8e121f759d464173.tar.xz lasso-9aa68aa4efb6d050e42bd70f8e121f759d464173.zip | |
improve documentation of lasso_login_build_artifact_msg
| -rw-r--r-- | lasso/id-ff/login.c | 31 |
1 files changed, 30 insertions, 1 deletions
diff --git a/lasso/id-ff/login.c b/lasso/id-ff/login.c index 51af8ed3..8c193756 100644 --- a/lasso/id-ff/login.c +++ b/lasso/id-ff/login.c @@ -841,15 +841,44 @@ lasso_login_build_assertion_artifact(LassoLogin *login) * @msg_relayState (POST). * * Return value: 0 on success; or + * <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_REMOTE_PROVIDERID if no remote provider ID was setup in the login + * </para></listitem> + * <listitem><para> * profile object, it's usually done by lasso_login_process_authn_request_msg, + * </para></listitem> + * <listitem><para> * LASSO_PROFILE_ERROR_INVALID_HTTP_METHOD if the HTTP method is neither LASSO_HTTP_METHOD_REDIRECT + * </para></listitem> + * <listitem><para> * or LASSO_HTTP_METHOD_POST (ID-FF 1.2 case) or neither LASSO_HTTP_METHOD_ARTIFACT_GET or + * </para></listitem> + * <listitem><para> * LASSO_HTTP_METHOD_ARTIFACT_POST (SAML 2.0 case) for SAML 2.0), + * </para></listitem> + * <listitem><para> * LASSO_PROFILE_ERROR_INVALID_PROTOCOLPROFILE if the current protocolProfile is not + * </para></listitem> + * <listitem><para> * LASSO_LOGIN_PROTOCOL_PROFILE_BRWS_ART (only for ID-FF 1.2), - * LASSO_SERVER_ERROR_PROVIDER_NOT_FOUND if the remote provider is not known to our server object. + * </para></listitem> + * <listitem><para> + * LASSO_SERVER_ERROR_PROVIDER_NOT_FOUND if the remote provider is not known to our server object + * </para></listitem> + * <listitem><para> + * which impeach us to find a service endpoint, + * </para></listitem> + * <listitem><para> + * LASSO_PROFILE_ERROR_MISSING_RESPONSE if the response object is missing, + * </para></listitem> + * <listitem><para> + * LASSO_PROFILE_ERROR_MISSING_STATUS_CODE if the response object is missing a status code, + * </para></listitem> + *</itemizedlist> * **/ gint |