Summary:
Logs the specified user in and creates a permanent session.
Request specification:
Name |
Min/Max |
Type |
Description |
|
|
User login info. To get the list of the available realms, use the |
|
|
|
|
|
|
|
|
User password. |
|
|
|
|
Returns:
Name |
Min/Max |
Type |
Description |
|
|
A token containing the user security information. |
Description:
The login
call logs the specified user in and creates a permanent session. Once created, this type of session becomes the default session for the physical connection used. This means that if you execute an Agent request without specifying the session ID, the request will be sent through this session. A permanent session never expires. The additional, user sessions can be created (if desired) only after the permanent session is created. The user sessions are created using the sessionm/login
call. To close the permanent session, simply disconnect from Agent and the session will be automatically terminated.
Example:
Input
Logging in as the root
user from the System realm (the host operating system user registry).
<packet version="4.0.0">
<data>
<system>
<login>
<name>cm9vdA==</name>
<realm>00000000-0000-0000-0000-000000000000</realm>
<password>bXlwYXNz</password>
</login>
</system>
</data>
</packet>
Output
The output contains the security IDs of the user and the groups the user belongs to.
<ns1:packet xmlns:ns3="http://www.swsoft.com/webservices/vzl/4.0.0/types" xmlns:ns2="http://www.swsoft.com/webservices/vzl/4.0.0/
system" xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/protocol" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="c9c46714aa5t135b8110r18fa" priority="0" version="4.0.0">
<ns1:origin>system</ns1:origin>
<ns1:target>vzclient14-cc98fba9-f1d6-fa46-b501-08dd4a0f0050</ns1:target>
<ns1:data>
<ns1:system>
<ns2:token xsi:type="ns3:tokenType">
<ns3:user>AQUAAAAAIAGp+5jM1vFG+rUBCN1KDwBQAAAAAA==</ns3:user>
<ns3:groups>
<ns3:sid>AQUAAAAAIACp+5jM1vFG+rUBCN1KDwBQAAAAAA==</ns3:sid>
<ns3:sid>AQUAAAAAIACp+5jM1vFG+rUBCN1KDwBQAQAAAA==</ns3:sid>
<ns3:sid>AQUAAAAAIACp+5jM1vFG+rUBCN1KDwBQCgAAAA==</ns3:sid>
<ns3:sid>AQUAAAAAIACp+5jM1vFG+rUBCN1KDwBQAgAAAA==</ns3:sid>
<ns3:sid>AQUAAAAAIACp+5jM1vFG+rUBCN1KDwBQAwAAAA==</ns3:sid>
<ns3:sid>AQUAAAAAIACp+5jM1vFG+rUBCN1KDwBQBAAAAA==</ns3:sid>
<ns3:sid>AQUAAAAAIACp+5jM1vFG+rUBCN1KDwBQBgAAAA==</ns3:sid>
<ns3:sid>AQUAAAAAIAGp+5jM1vFG+rUBCN1KDwBQAAAAAA==</ns3:sid>
</ns3:groups>
<ns3:deny_only_sids/>
<ns3:privileges/>
</ns2:token>
</ns1:system>
</ns1:data>
</ns1:packet>
Input
Logging in as the root
user of one of the Virtuozzo Containers. The Realm ID used here is the ID of the Virtuozzo Container Realm (one of the built-in Realms). When the Virtuozzo Container Realm ID is specified, it means that the authentication should be performed against the user registry inside the Virtuozzo Container specified in the domain
field. The domain
parameter contains the Server ID of the Container.
<packet version="4.0.0" id="3">
<data>
<system>
<login>
<name>cm9vdA==</name>
<domain>ZTlhYjI4MzQtZWQ5Ny0xZjRiLWJkNDEtODFjMjdmYWNmYzMw</domain>
<realm>00000000-0000-0000-0100-000000000000</realm>
<password>TXlQYXNz</password>
</login>
</system>
</data>
</packet>