← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/lasso/intrepid-updates

« back to all changes in this revision

Viewing changes to docs/reference/html/LassoLibAuthnRequest.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2006-07-11 10:01:32 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20060711100132-e50ymjc54bsizza6
Tags: 0.6.5-2ubuntu1
* Synchronize with Debian unstable.
* Convert to updated Python policy.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/LassoLibAuthnRequest.html
1
 
<html>
2
 
<head>
3
 
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4
 
<title>LassoLibAuthnRequest</title>
5
 
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
6
 
<link rel="start" href="index.html" title="Lasso Reference Manual">
7
 
<link rel="up" href="xml.html" title="Schemas">
8
 
<link rel="prev" href="LassoLibAuthnContext.html" title="LassoLibAuthnContext">
9
 
<link rel="next" href="lasso-LassoLibAuthnRequestEnvelope.html" title="LassoLibAuthnRequestEnvelope">
10
 
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
11
 
<link rel="stylesheet" href="style.css" type="text/css">
12
 
<link rel="chapter" href="lasso.html" title="Lasso &amp; Liberty Alliance Overview">
13
 
<link rel="chapter" href="architecture.html" title="Lasso Architecture">
14
 
<link rel="chapter" href="idff.html" title="Identity Federation Framework">
15
 
<link rel="chapter" href="idwsf.html" title="Identity Web Services Framework">
16
 
<link rel="chapter" href="xml.html" title="Schemas">
17
 
<link rel="chapter" href="misc.html" title="Misc">
18
 
</head>
19
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
20
 
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
21
 
<td><a accesskey="p" href="LassoLibAuthnContext.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
22
 
<td><a accesskey="u" href="xml.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
23
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
24
 
<th width="100%" align="center">Lasso Reference Manual</th>
25
 
<td><a accesskey="n" href="lasso-LassoLibAuthnRequestEnvelope.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
26
 
</tr></table>
27
 
<div class="refentry" lang="en">
28
 
<a name="LassoLibAuthnRequest"></a><div class="titlepage"></div>
29
 
<div class="refnamediv"><table width="100%"><tr>
30
 
<td valign="top">
31
 
<h2><span class="refentrytitle">LassoLibAuthnRequest</span></h2>
32
 
<p>LassoLibAuthnRequest &#8212; &lt;lib:AuthnRequest&gt;</p>
33
 
</td>
34
 
<td valign="top" align="right"></td>
35
 
</tr></table></div>
36
 
<div class="refsynopsisdiv">
37
 
<h2>Synopsis</h2>
38
 
<pre class="synopsis">
39
 
 
40
 
#include &lt;lasso/lasso.h&gt;
41
 
 
42
 
 
43
 
            <a href="LassoLibAuthnRequest.html#LassoLibAuthnRequest-struct">LassoLibAuthnRequest</a>;
44
 
<a href="LassoLibAuthnRequest.html" title="LassoLibAuthnRequest">LassoLibAuthnRequest</a>* <a href="LassoLibAuthnRequest.html#lasso-lib-authn-request-new">lasso_lib_authn_request_new</a>
45
 
                                            (void);
46
 
 
47
 
</pre>
48
 
</div>
49
 
<div class="refsect1" lang="en">
50
 
<a name="id2562152"></a><h2>Object Hierarchy</h2>
51
 
<pre class="synopsis">
52
 
 
53
 
  <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK>
54
 
   +----<a href="LassoNode.html" title="LassoNode">LassoNode</a>
55
 
         +----<a href="LassoSamlpRequestAbstract.html" title="LassoSamlpRequestAbstract">LassoSamlpRequestAbstract</a>
56
 
               +----LassoLibAuthnRequest
57
 
</pre>
58
 
</div>
59
 
<div class="refsect1" lang="en">
60
 
<a name="id2562584"></a><h2>Description</h2>
61
 
<p>
62
 
Authentication requests are sent from a service provider to an identity
63
 
provider.
64
 
</p>
65
 
</div>
66
 
<div class="refsect1" lang="en">
67
 
<a name="id2562595"></a><h2>Details</h2>
68
 
<div class="refsect2" lang="en">
69
 
<a name="id2562601"></a><h3>
70
 
<a name="LassoLibAuthnRequest-struct"></a>LassoLibAuthnRequest</h3>
71
 
<a class="indexterm" name="id2562612"></a><pre class="programlisting">typedef struct {
72
 
        /* &lt;xs:element ref="Extension" minOccurs="0" maxOccurs="unbounded"/&gt; */
73
 
        GList *Extension;
74
 
        /* &lt;xs:element ref="ProviderID"/&gt; */
75
 
        char *ProviderID;
76
 
        /* &lt;xs:element ref="AffiliationID" minOccurs="0"/&gt; */
77
 
        char *AffiliationID;
78
 
        /* &lt;xs:element ref="NameIDPolicy" minOccurs="0"/&gt; */
79
 
        char *NameIDPolicy;
80
 
        /* &lt;xs:element name="ForceAuthn" type="xs:boolean" minOccurs="0"/&gt; */
81
 
        gboolean ForceAuthn;
82
 
        /* &lt;xs:element name="IsPassive" type="xs:boolean "minOccurs="0"/&gt; */
83
 
        gboolean IsPassive;
84
 
        /* &lt;xs:element ref="ProtocolProfile" minOccurs="0"/&gt; */
85
 
        char *ProtocolProfile;
86
 
        /* &lt;xs:element name="AssertionConsumerServiceID" type="xs:string" minOccurs="0"/&gt; */
87
 
        char *AssertionConsumerServiceID;
88
 
        /* &lt;xs:element ref="RequestAuthnContext" minOccurs="0"/&gt; */
89
 
        LassoLibRequestAuthnContext *RequestAuthnContext;
90
 
        /* &lt;xs:element ref="RelayState" minOccurs="0"/&gt; */
91
 
        char *RelayState;
92
 
        /* &lt;xs:element ref="Scoping" minOccurs="0 "/&gt; */
93
 
        LassoLibScoping *Scoping;
94
 
        /* &lt;xs:attribute ref="consent" use="optional"/&gt; */
95
 
        char *consent;
96
 
} LassoLibAuthnRequest;
97
 
</pre>
98
 
<p>
99
 
<em class="parameter"><code>ProviderID</code></em> is the service provider identifier, this field will often be filled
100
 
with <a href="LassoLogin.html#lasso-login-init-authn-request"><code class="function">lasso_login_init_authn_request()</code></a>.
101
 
</p>
102
 
<p>
103
 
<em class="parameter"><code>nameIDPolicy</code></em> tells the identity provider about the policy to use for
104
 
federation; it must be one of <a href="lasso-strings.html#LASSO-LIB-NAMEID-POLICY-TYPE-NONE:CAPS"><span class="type">LASSO_LIB_NAMEID_POLICY_TYPE_NONE</span></a>,
105
 
<a href="lasso-strings.html#LASSO-LIB-NAMEID-POLICY-TYPE-ONE-TIME:CAPS"><span class="type">LASSO_LIB_NAMEID_POLICY_TYPE_ONE_TIME</span></a>, <a href="lasso-strings.html#LASSO-LIB-NAMEID-POLICY-TYPE-FEDERATED:CAPS"><span class="type">LASSO_LIB_NAMEID_POLICY_TYPE_FEDERATED</span></a>
106
 
or <a href="lasso-strings.html#LASSO-LIB-NAMEID-POLICY-TYPE-ANY:CAPS"><span class="type">LASSO_LIB_NAMEID_POLICY_TYPE_ANY</span></a>.
107
 
</p>
108
 
<p>
109
 
<em class="parameter"><code>IsPassive</code></em>; if <code class="literal">TRUE</code> (default) it tells the identity provider not to interact
110
 
with the user.
111
 
</p>
112
 
<p>
113
 
<em class="parameter"><code>ForceAuthn</code></em>; only used if <em class="parameter"><code>IsPassive</code></em> is <code class="literal">FALSE</code>, it tells the identity provider
114
 
to force authentication of the user even when already authenticated.
115
 
</p>
116
 
<p>
117
 
<em class="parameter"><code>ProtocolProfile</code></em> is the Single Sign-On and Federation profile to adopt; either
118
 
<a href="lasso-strings.html#LASSO-LIB-PROTOCOL-PROFILE-BRWS-ART:CAPS"><span class="type">LASSO_LIB_PROTOCOL_PROFILE_BRWS_ART</span></a> (which is the default value) or
119
 
<a href="lasso-strings.html#LASSO-LIB-PROTOCOL-PROFILE-BRWS-POST:CAPS"><span class="type">LASSO_LIB_PROTOCOL_PROFILE_BRWS_POST</span></a>.
120
 
</p>
121
 
</div>
122
 
<hr>
123
 
<div class="refsect2" lang="en">
124
 
<a name="id2562806"></a><h3>
125
 
<a name="lasso-lib-authn-request-new"></a>lasso_lib_authn_request_new ()</h3>
126
 
<a class="indexterm" name="id2562818"></a><pre class="programlisting"><a href="LassoLibAuthnRequest.html" title="LassoLibAuthnRequest">LassoLibAuthnRequest</a>* lasso_lib_authn_request_new
127
 
                                            (void);</pre>
128
 
<p>
129
 
Creates a new <a href="LassoLibAuthnRequest.html" title="LassoLibAuthnRequest"><span class="type">LassoLibAuthnRequest</span></a> object.</p>
130
 
<p>
131
 
 
132
 
</p>
133
 
<div class="variablelist"><table border="0">
134
 
<col align="left" valign="top">
135
 
<tbody><tr>
136
 
<td>
137
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
138
 
<td> a newly created <a href="LassoLibAuthnRequest.html" title="LassoLibAuthnRequest"><span class="type">LassoLibAuthnRequest</span></a> object
139
 
</td>
140
 
</tr></tbody>
141
 
</table></div>
142
 
</div>
143
 
</div>
144
 
<div class="refsect1" lang="en">
145
 
<a name="id2562877"></a><h2>See Also</h2>
146
 
<p>
147
 
</p>
148
 
<div class="variablelist"><table border="0">
149
 
<col align="left" valign="top">
150
 
<tbody><tr>
151
 
<td>
152
 
<span class="term"><a href="LassoLogin.html" title="LassoLogin"><span class="type">LassoLogin</span></a></span></td>
153
 
<td><p>Class for Single Sign-On and Federation
154
 
profile.</p></td>
155
 
</tr></tbody>
156
 
</table></div>
157
 
<p>
158
 
</p>
159
 
</div>
160
 
</div>
161
 
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
162
 
<td align="left"><a accesskey="p" href="LassoLibAuthnContext.html"><b>&lt;&lt;&#160;LassoLibAuthnContext</b></a></td>
163
 
<td align="right"><a accesskey="n" href="lasso-LassoLibAuthnRequestEnvelope.html"><b>LassoLibAuthnRequestEnvelope&#160;&gt;&gt;</b></a></td>
164
 
</tr></table>
165
 
</body>
166
 
</html>