<back to all web services
LoginSystemAdminReq
Virtuozzo
The following routes are available for this service:| POST | /virtuozzo/auth/system/post | Log into the system | |
|---|
LoginVirtuozzoBase Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Login | body | TypeLogin | No | The TypeLogin for Virtuozzo |
TypeLogin Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| MembershipId | form | int | No | |
| UserId | form | Guid | No | |
| Username | form | string | No | |
| Password | form | string | No | |
| DatacenterURL | form | string | No | |
| LocationType | form | string | No | |
| DatacenterLocation | form | DatacenterLocations | No | |
| Location | form | string | No | |
| ApplicationName | form | string | No | |
| ApplicationId | form | Guid | No | |
| ApplicationLocationId | form | Guid | No | |
| CompanyName | form | string | No | |
| CompanyId | form | Guid | No | |
| Status | form | int | No | |
| Rights | form | List<string> | No | |
| SessionId | form | string | No | |
| Roles | form | List<string> | No | |
| Permissions | form | List<string> | No | |
| Attributes | form | List<TypeMembershipAttribute> | No | |
| UseTwoFactorAuth | form | bool | No | |
| PresharedKey | form | string | No | |
| Passcode | form | string | No | |
| Id | form | string | No | |
DatacenterLocations Enum:| ACD | |
| GMU | |
| SPA | |
| LAS | |
| DEV | |
| VCD | |
| AWS | |
| GCP | |
| UAT | |
| AZU | |
| CNW | |
| AUV | |
| ATL | |
| EXT | |
TypeMembershipAttribute Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| AttributeType | form | string | No | |
| AttributeValue | form | string | No | |
| AttributeDataType | form | string | No | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /virtuozzo/auth/system/post HTTP/1.1
Host: n3tapi.palmettovdc.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<LoginSystemAdminReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services.Virtuozzo.Request">
<Login xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">
<d2p1:ApplicationId>00000000-0000-0000-0000-000000000000</d2p1:ApplicationId>
<d2p1:ApplicationLocationId>00000000-0000-0000-0000-000000000000</d2p1:ApplicationLocationId>
<d2p1:ApplicationName>String</d2p1:ApplicationName>
<d2p1:Attributes>
<d2p1:TypeMembershipAttribute>
<d2p1:AttributeDataType>String</d2p1:AttributeDataType>
<d2p1:AttributeType>String</d2p1:AttributeType>
<d2p1:AttributeValue>String</d2p1:AttributeValue>
</d2p1:TypeMembershipAttribute>
</d2p1:Attributes>
<d2p1:CompanyId>00000000-0000-0000-0000-000000000000</d2p1:CompanyId>
<d2p1:CompanyName>String</d2p1:CompanyName>
<d2p1:DatacenterLocation>ACD</d2p1:DatacenterLocation>
<d2p1:DatacenterURL>String</d2p1:DatacenterURL>
<d2p1:Id>String</d2p1:Id>
<d2p1:Location>String</d2p1:Location>
<d2p1:LocationType>String</d2p1:LocationType>
<d2p1:MembershipId>0</d2p1:MembershipId>
<d2p1:Passcode>String</d2p1:Passcode>
<d2p1:Password>String</d2p1:Password>
<d2p1:Permissions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</d2p1:Permissions>
<d2p1:PresharedKey>String</d2p1:PresharedKey>
<d2p1:Rights xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</d2p1:Rights>
<d2p1:Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</d2p1:Roles>
<d2p1:SessionId>String</d2p1:SessionId>
<d2p1:Status>0</d2p1:Status>
<d2p1:UseTwoFactorAuth>false</d2p1:UseTwoFactorAuth>
<d2p1:UserId>00000000-0000-0000-0000-000000000000</d2p1:UserId>
<d2p1:Username>String</d2p1:Username>
</Login>
</LoginSystemAdminReq>