POST api/SecurityV01

Deprecated - Logins user and returns details of user along with security token.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Username		string	None.
Password		string	None.

Request Formats

application/json, text/json

Sample:

{
  "Username": "sample string 1",
  "Password": "sample string 2"
}

application/xml, text/xml

Sample:

<LoginRequestV01 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VisibleSecurity.Core.Request">
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</LoginRequestV01>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns details of user if successfully logged in.

VscmLoginResponseV01

Name	Type	Additional information
SecurityToken	string	None.
VscmUser	VscmUserResponseV01	None.
IsSuccessful	boolean	None.
Message	string	None.
TimeInMs	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "SecurityToken": "sample string 1",
  "VscmUser": {
    "UserId": 1,
    "UserName": "sample string 2",
    "IsActive": true,
    "IsInternalUser": true,
    "IsAdminUser": true,
    "StartDate": "2024-05-02T22:25:23.1023926+00:00",
    "EndDate": "2024-05-02T22:25:23.1138313+00:00",
    "EmailAddress": "sample string 8",
    "UserFullName": "sample string 9",
    "SecurityFeatures": [
      "sample string 1",
      "sample string 2"
    ],
    "Clients": [
      {
        "ClientName": "sample string 1",
        "DisplayClientName": "sample string 2",
        "Active": true,
        "Aliases": [
          {
            "ClientAliasName": "sample string 1",
            "IsSuccessful": true,
            "Message": "sample string 2",
            "TimeInMs": 1.1
          },
          {
            "ClientAliasName": "sample string 1",
            "IsSuccessful": true,
            "Message": "sample string 2",
            "TimeInMs": 1.1
          }
        ],
        "IsSuccessful": true,
        "Message": "sample string 4",
        "TimeInMs": 1.1
      },
      {
        "ClientName": "sample string 1",
        "DisplayClientName": "sample string 2",
        "Active": true,
        "Aliases": [
          {
            "ClientAliasName": "sample string 1",
            "IsSuccessful": true,
            "Message": "sample string 2",
            "TimeInMs": 1.1
          },
          {
            "ClientAliasName": "sample string 1",
            "IsSuccessful": true,
            "Message": "sample string 2",
            "TimeInMs": 1.1
          }
        ],
        "IsSuccessful": true,
        "Message": "sample string 4",
        "TimeInMs": 1.1
      }
    ],
    "BusinessUnits": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "IsSuccessful": true,
  "Message": "sample string 2",
  "TimeInMs": 1.1
}

application/xml, text/xml

Sample:

<VscmLoginResponseV01 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VisibleSecurity.Core.Response">
  <IsSuccessful>true</IsSuccessful>
  <Message>sample string 2</Message>
  <TimeInMs>1.1</TimeInMs>
  <SecurityToken>sample string 1</SecurityToken>
  <VscmUser>
    <BusinessUnits xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </BusinessUnits>
    <Clients>
      <VscmClientResponseV01>
        <IsSuccessful>true</IsSuccessful>
        <Message>sample string 4</Message>
        <TimeInMs>1.1</TimeInMs>
        <Active>true</Active>
        <Aliases>
          <VscmClientAliasResponseV01>
            <IsSuccessful>true</IsSuccessful>
            <Message>sample string 2</Message>
            <TimeInMs>1.1</TimeInMs>
            <ClientAliasName>sample string 1</ClientAliasName>
          </VscmClientAliasResponseV01>
          <VscmClientAliasResponseV01>
            <IsSuccessful>true</IsSuccessful>
            <Message>sample string 2</Message>
            <TimeInMs>1.1</TimeInMs>
            <ClientAliasName>sample string 1</ClientAliasName>
          </VscmClientAliasResponseV01>
        </Aliases>
        <ClientName>sample string 1</ClientName>
        <DisplayClientName>sample string 2</DisplayClientName>
      </VscmClientResponseV01>
      <VscmClientResponseV01>
        <IsSuccessful>true</IsSuccessful>
        <Message>sample string 4</Message>
        <TimeInMs>1.1</TimeInMs>
        <Active>true</Active>
        <Aliases>
          <VscmClientAliasResponseV01>
            <IsSuccessful>true</IsSuccessful>
            <Message>sample string 2</Message>
            <TimeInMs>1.1</TimeInMs>
            <ClientAliasName>sample string 1</ClientAliasName>
          </VscmClientAliasResponseV01>
          <VscmClientAliasResponseV01>
            <IsSuccessful>true</IsSuccessful>
            <Message>sample string 2</Message>
            <TimeInMs>1.1</TimeInMs>
            <ClientAliasName>sample string 1</ClientAliasName>
          </VscmClientAliasResponseV01>
        </Aliases>
        <ClientName>sample string 1</ClientName>
        <DisplayClientName>sample string 2</DisplayClientName>
      </VscmClientResponseV01>
    </Clients>
    <EmailAddress>sample string 8</EmailAddress>
    <EndDate>2024-05-02T22:25:23.1138313+00:00</EndDate>
    <IsActive>true</IsActive>
    <IsAdminUser>true</IsAdminUser>
    <IsInternalUser>true</IsInternalUser>
    <SecurityFeatures xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </SecurityFeatures>
    <StartDate>2024-05-02T22:25:23.1023926+00:00</StartDate>
    <UserFullName>sample string 9</UserFullName>
    <UserId>1</UserId>
    <UserName>sample string 2</UserName>
  </VscmUser>
</VscmLoginResponseV01>