Previous page

Next page

Locate page in Contents

Print this page

authenticate

Summary:

Authenticates the specified user.

Request specification:

Name

Min/Max

Type

Description

authenticate

1..1

auth_nameType

The inherited auth_nameType portion is used to specify the user login information.

{

 

 

 

password

1..1

base64Binary

The password of the user account specified in the auth_nameType portion.

}

 

 

 

Returns:

Name

Min/Max

Type

Description

token

1..1

tokenType

The security token for the user.

Returns error if the user credentials are invalid.

Description:

The call authenticates a user against the specified realm. Unlike the sessionm/login call, this call does not log the user in and does not create a session for the user. It simply verifies the identity of the user and, in case of success, returns the user security information.

Example:

Input

<packet version="4.0.0" id="2">

<target>authm</target>

<data>

<authm>

<authenticate>

<name>VGVzdF9Vc2Vy</name>

<realm>3e761571-6607-1344-a064-a42679da8ed9</realm>

<password>bXlwYXNz</password>

</authenticate>

</authm>

</data>

</packet>

Output

<?xml version="1.0" encoding="UTF-8"?><packet xmlns:ns3="http://www.swsoft.com/webservices/vzl/4.0.0/types" xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/protocol" xmlns:ns2="http://www.swsoft.com/webservices/vzl/4.0.0/authm" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="ec469f8070t6952r9c4" time="2007-07-19T02:13:12+0000" priority="0" version="4.0.0">

<ns1:origin>authm</ns1:origin>

<ns1:target>vzclient5-2cbbe469-8f57-7f46-97fb-fd987231d957</ns1:target>

<ns1:dst>

<ns1:director>gend</ns1:director>

</ns1:dst>

<ns1:data>

<ns2:authm>

<ns2:token xsi:type="ns3:tokenType">

<ns3:user>AQUAAAAAIAHTZdZTIXhCiJzs2URXL/tM/wEAAA==</ns3:user>

<ns3:groups>

<ns3:sid>AQUAAAAAIAHTZdZTIXhCiJzs2URXL/tM/wEAAA==</ns3:sid>

</ns3:groups>

<ns3:deny_only_sids/>

<ns3:privileges/>

</ns2:token>

</ns2:authm>

</ns1:data>

<ns1:src>

<ns1:director>gend</ns1:director>

</ns1:src>

</packet>

Please send us your feedback on this help page