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
|
<?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="me_uddi_get_authToken">
<refmeta>
<refentrytitle>uddi_get_authToken</refentrytitle>
<refmiscinfo>uddi</refmiscinfo>
</refmeta>
<refnamediv>
<refname>uddi_get_authToken</refname>
<refpurpose>Obtain authentication token.</refpurpose>
</refnamediv>
<refsect1 id="syntax_uddi_get_authToken"><title>Syntax</title>
<screen>
<uddi_get_authToken
generic="1.0"
xmlns="urn:uddi-org:api"
userID="someLoginName"
cred="someCredential">
</uddi_get_authToken>
</screen></refsect1>
<refsect1 id="desc_uddi_get_authToken"><title>Description</title>
<para>
The <parameter>uddi_get_authToken</parameter> message is used to obtain an
authentication token. Authentication tokens are opaque values that are
required for all other publisher API calls. This message is not required
for UDDI-enabled servers that have an external mechanism defined for users
to get an authentication token. This API is provided for implementations
that do not have some other method of obtaining an authentication token or
certificate, or that choose to use password-based authentication.
</para></refsect1> <refsect1
id="params_uddi_get_authToken"><title>Attributes & Children</title>
<refsect2><title>userID</title> <para>This required attribute argument is
the identifier that an authorized entity was assigned by a UDDI-enabled
server. Each UDDI-enabled server provides a way for entities to obtain
userids and passwords that are valid only at that server.</para>
</refsect2>
<refsect2><title>cred</title><para>This required
attribute argument is the password or credential that is associated with
the entity.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_uddi_get_authToken"><title>Return Types</title>
<para>
<parameter>uddi_get_authToken</parameter> returns an
<parameter>authToken</parameter> message containing a valid
<parameter>authInfo</parameter> element usable in subsequent
calls requiring an <parameter>authInfo</parameter> value.
</para>
</refsect1>
<refsect1 id="errors_uddi_get_authToken"><title>Errors</title>
<para>
If an error occurs in processing this message, the server returns a
<parameter>dispositionReport</parameter> structure in a SOAP Fault. The
following error information will be relevant:
</para>
<table><title>Errors signalled by uddi_get_authToken</title>
<tgroup cols="2">
<thead><row><entry>Error Code</entry><entry>Description</entry></row></thead>
<tbody>
<row>
<entry><errorcode>E_unknownUser</errorcode></entry>
<entry>signifies that the UDDI-enabled server that received
the request does not recognize the userID and/or password argument values
passed as credentials</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
</refentry>
|
