# 22. Virtuoso Functions Guide - uddi_get_authToken

Chapter Contents | Prev | Next
Keyword Search:
www.openlinksw.com
docs.openlinksw.com
Book Home
Contents
Preface
Virtuoso Functions Guide
Administration
Aggregate Functions
Array Manipulation
BPEL APIs
Backup
Compression
Cursor
Date & Time Manipulation
Debug
Dictionary Manipulation
Encoding & Decoding
File Manipulation
Free Text
Hashing / Cryptographic
LDAP
Locale
Mail
Miscellaneous
Number
Remote SQL Data Source
Replication
SOAP
SQL
String
Transaction
Type Mapping
UDDI
uddi_delete_binding
uddi_delete_business
uddi_delete_service
uddi_delete_tmodel
uddi_discard_authtok...
uddi_find_binding
uddi_find_business
uddi_find_service
uddi_find_tmodel
uddi_get_authtoken
uddi_get_bindingdeta...
uddi_get_businessdet...
uddi_get_businessdet...
uddi_get_registeredi...
uddi_get_servicedeta...
uddi_get_tmodeldetai...
uddi_save_binding
uddi_save_business
uddi_save_service
uddi_save_tmodel
User Defined Types & The CLR
Virtuoso Java PL API
Virtuoso Server Extension Interface (VSEI)
Web Server & Internet
XML
XPATH & XQUERY
Functions Index

## uddi_get_authToken

Obtain authentication token.
Syntax

    <uddi_get_authToken
      generic="1.0"
      xmlns="urn:uddi-org:api"
      userID="someLoginName"
      cred="someCredential">
    </uddi_get_authToken>

Description

The uddi_get_authToken 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.

Attributes & Children
userID – 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.
cred – This required attribute argument is the password or credential that is associated with the entity.
Return Types

uddi_get_authToken returns an authToken message containing a valid authInfo element usable in subsequent calls requiring an authInfo value.

Errors

If an error occurs in processing this message, the server returns a dispositionReport structure in a SOAP Fault. The following error information will be relevant:

Error Code | Description
--- | ---
E_unknownUser | signifies that the UDDI-enabled server that received the request does not recognize the userID and/or password argument values passed as credentials