1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_wst_cli">
<refmeta>
<refentrytitle>wst_cli</refentrytitle>
<refmiscinfo>soap</refmiscinfo>
</refmeta>
<refnamediv>
<refname>wst_cli</refname>
<refpurpose>Request a security token from WST endpoint</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_wst_cli">
<funcprototype id="fproto_wst_cli">
<funcdef>token <function>wst_cli</function></funcdef>
<paramdef>in <parameter>req</parameter> soap_client_req</paramdef>
<paramdef>in <parameter>policy</parameter> any</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_wst_cli">
<title>Description</title>
<para>This function is for use with a SOAP client contacting a WS-Trust
endpoint for a security token.</para>
</refsect1>
<refsect1 id="params_wst_cli">
<title>Parameters</title>
<refsect2><title>req</title>
<para>A UDT containing soap_client parameters as described in
WS-RM.</para>
</refsect2>
<refsect2><title>policy</title>
<para>contains policy to be applied, an example:</para>
<programlisting><![CDATA[
create type policy_struct as
(
usage - integrity/confidentiality
token_type - wsse token type: x509; context token etc.
token_issuer - URL of the issuer
user_name - represent to issuer,
user_pass,
debug - dump req/res. 1 - for RequestSecurityToken, 2 - end point
token - base64 encoded Binary Security Token
)
]]></programlisting>
</refsect2>
</refsect1>
<refsect1 id="ret_wst_cli"><title>Return Types</title>
<para>A security token.</para>
</refsect1>
<!-- <refsect1 id="errors_wst_cli">
<title>Errors</title>
In case of non-function-specific errors, i.e. only common
parameter errors are signalled, comment out the table below
otherwise add the unique error values as individual errorcodes
<para>This function can generate the following errors:</para>
<errorcode></errorcode>
</refsect1>
<refsect1 id="examples_wst_cli">
<title>Examples</title>
<example id="ex_wst_cli"><title></title>
<para></para>
<screen><![CDATA[
]]>
</screen>
</example>
</refsect1>
-->
<refsect1 id="seealso_wst_cli">
<title>See Also</title>
<para><link linkend="warm">WS Reliable Messaging</link></para>
</refsect1>
</refentry>
|
