POST SecurityV00/Login?userName={userName}&password={password}
Logins user and returns details of user along with security token.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
userName | string |
Required |
|
password | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns details of user if successfully logged in.
VSCUserLoginResponseName | Description | Type | Additional information |
---|---|---|---|
User | VSCMUser |
None. |
|
Clients | Collection of VSCClient |
None. |
|
ParentClient | string |
None. |
|
ClientName | string |
None. |
|
SubClientName | string |
None. |
|
Errors | Collection of string |
None. |
|
ResultCode | string |
None. |
|
SecurityToken | string |
None. |
|
TimeInMs | decimal number |
None. |
|
ResultPath | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "User": { "UserId": 1, "Name": "sample string 2", "Active": true, "StartDate": "2024-05-03T18:48:15.7953104+00:00", "EndDate": "2024-05-03T18:48:15.7953104+00:00", "Department": "sample string 6", "Password": "sample string 7", "SecurityFeatures": [ { "Id": 1, "FeatureName": "sample string 2", "ClientName": "sample string 3", "DBStatus": 0, "ModifiedTimeStamp": "2024-05-03T18:48:15.8265729+00:00", "CreatedSessionId": 5, "ModifiedSessionId": 6, "RowVersion": "QEA=" }, { "Id": 1, "FeatureName": "sample string 2", "ClientName": "sample string 3", "DBStatus": 0, "ModifiedTimeStamp": "2024-05-03T18:48:15.8265729+00:00", "CreatedSessionId": 5, "ModifiedSessionId": 6, "RowVersion": "QEA=" } ], "SessionId": "sample string 8", "EmailAddress": "sample string 9", "UserFullName": "sample string 10", "DBStatus": 0 }, "Clients": [ { "Id": 1, "ClientDisplayName": "sample string 2", "ClientName": "sample string 3", "Active": true, "DBStatus": 0, "ModifiedTimeStamp": "2024-05-03T18:48:15.8265729+00:00", "CreatedSessionId": 6, "ModifiedSessionId": 7, "RowVersion": "QEA=" }, { "Id": 1, "ClientDisplayName": "sample string 2", "ClientName": "sample string 3", "Active": true, "DBStatus": 0, "ModifiedTimeStamp": "2024-05-03T18:48:15.8265729+00:00", "CreatedSessionId": 6, "ModifiedSessionId": 7, "RowVersion": "QEA=" } ], "ParentClient": "sample string 1", "ClientName": "sample string 2", "SubClientName": "sample string 3", "Errors": [ "sample string 1", "sample string 2" ], "MethodName": "sample string 4", "ResultCode": "sample string 5", "SecurityToken": "sample string 6", "TimeInMs": 7.1, "ResultPath": "sample string 8" }
application/xml, text/xml
Sample:
<VSCUserLoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VisibleSecurity.Core.Legacy"> <ClientName>sample string 2</ClientName> <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Errors> <MethodName>sample string 4</MethodName> <ResultCode>sample string 5</ResultCode> <ResultPath>sample string 8</ResultPath> <SecurityToken>sample string 6</SecurityToken> <SubClientName>sample string 3</SubClientName> <TimeInMs>7.1</TimeInMs> <Clients> <VSCClient> <ClientName></ClientName> <CreatedSessionId>6</CreatedSessionId> <DBStatus>Unknown</DBStatus> <ModifiedSessionId>7</ModifiedSessionId> <ModifiedTimeStamp>2024-05-03T18:48:15.8265729+00:00</ModifiedTimeStamp> <RowVersion>QEA=</RowVersion> <Active>true</Active> <ClientDisplayName>sample string 2</ClientDisplayName> <ClientName>sample string 3</ClientName> <Id>1</Id> </VSCClient> <VSCClient> <ClientName></ClientName> <CreatedSessionId>6</CreatedSessionId> <DBStatus>Unknown</DBStatus> <ModifiedSessionId>7</ModifiedSessionId> <ModifiedTimeStamp>2024-05-03T18:48:15.8265729+00:00</ModifiedTimeStamp> <RowVersion>QEA=</RowVersion> <Active>true</Active> <ClientDisplayName>sample string 2</ClientDisplayName> <ClientName>sample string 3</ClientName> <Id>1</Id> </VSCClient> </Clients> <ParentClient>sample string 1</ParentClient> <User> <DBStatus>Unknown</DBStatus> <Active>true</Active> <Department>sample string 6</Department> <EmailAddress>sample string 9</EmailAddress> <EndDate>2024-05-03T18:48:15.7953104+00:00</EndDate> <Name>sample string 2</Name> <Password>sample string 7</Password> <SecurityFeatures> <VSCSecurityFeature> <ClientName>sample string 3</ClientName> <CreatedSessionId>5</CreatedSessionId> <DBStatus>Unknown</DBStatus> <ModifiedSessionId>6</ModifiedSessionId> <ModifiedTimeStamp>2024-05-03T18:48:15.8265729+00:00</ModifiedTimeStamp> <RowVersion>QEA=</RowVersion> <FeatureName>sample string 2</FeatureName> <Id>1</Id> </VSCSecurityFeature> <VSCSecurityFeature> <ClientName>sample string 3</ClientName> <CreatedSessionId>5</CreatedSessionId> <DBStatus>Unknown</DBStatus> <ModifiedSessionId>6</ModifiedSessionId> <ModifiedTimeStamp>2024-05-03T18:48:15.8265729+00:00</ModifiedTimeStamp> <RowVersion>QEA=</RowVersion> <FeatureName>sample string 2</FeatureName> <Id>1</Id> </VSCSecurityFeature> </SecurityFeatures> <SessionId>sample string 8</SessionId> <StartDate>2024-05-03T18:48:15.7953104+00:00</StartDate> <UserFullName>sample string 10</UserFullName> <UserId>1</UserId> </User> </VSCUserLoginResponse>