POST api/authenticate?slug={slug}

Request Information

URI Parameters

Name	Description	Type	Additional information
slug		string	None.

Body Parameters

AuthenticationViewModel

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

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<AuthenticationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Shared.Models.ViewModels">
  <Password>sample string 1</Password>
  <UserName>sample string 2</UserName>
</AuthenticationViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CredentialsViewModel

Name	Type	Additional information
AuthenticationToken	globally unique identifier	None.
IsLockedOut	boolean	None.
IsValid	boolean	None.
RemainingLockedOutSeconds	decimal number	None.
RequireTwoFactorAuth	boolean	None.
TwoFactorAuthUri	string	None.
UserCompanyId	integer	None.
UserId	globally unique identifier	None.
UserName	string	None.
VobeSoftAuthenticationTicket	string	None.
VobeSoftSessionId	string	None.
Redirect	string	None.

Response Formats

application/json, text/json

Sample:

{
  "AuthenticationToken": "e374ab34-179d-4e49-b758-b9511eebfa99",
  "IsLockedOut": true,
  "IsValid": true,
  "RemainingLockedOutSeconds": 4.1,
  "RequireTwoFactorAuth": true,
  "TwoFactorAuthUri": "sample string 6",
  "UserCompanyId": 7,
  "UserId": "f87a23e6-2cda-43ff-a0bc-ce5f78588104",
  "UserName": "sample string 9",
  "VobeSoftAuthenticationTicket": "sample string 10",
  "VobeSoftSessionId": "sample string 11",
  "Redirect": "sample string 12"
}

application/xml, text/xml

Sample:

<CredentialsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Shared.Models.ViewModels">
  <AuthenticationToken>e374ab34-179d-4e49-b758-b9511eebfa99</AuthenticationToken>
  <IsLockedOut>true</IsLockedOut>
  <IsValid>true</IsValid>
  <Redirect>sample string 12</Redirect>
  <RemainingLockedOutSeconds>4.1</RemainingLockedOutSeconds>
  <RequireTwoFactorAuth>true</RequireTwoFactorAuth>
  <TwoFactorAuthUri>sample string 6</TwoFactorAuthUri>
  <UserCompanyId>7</UserCompanyId>
  <UserId>f87a23e6-2cda-43ff-a0bc-ce5f78588104</UserId>
  <UserName>sample string 9</UserName>
  <VobeSoftAuthenticationTicket>sample string 10</VobeSoftAuthenticationTicket>
  <VobeSoftSessionId>sample string 11</VobeSoftSessionId>
</CredentialsViewModel>