POST api/Security/GeneratePersistentToken

Authenticate the given login credentials and generate a persistent authentication token. This action requires a valid authentication token

Request Information

URI Parameters

None.

Body Parameters

Login Credentials

AuthenticationInput
NameDescriptionTypeAdditional information
Username

User Name for Login

 string

Required
Password

Password for Login

 string

Required

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample: 
<AuthenticationInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.Base.WebAPI.Models">
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</AuthenticationInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Instance of AuthenticatedUserModel - With AuthenticationToken. Failed response includes Http Status 400, 401, 500

AuthenticatedUserModel
NameDescriptionTypeAdditional information
IsAuthenticated

Indicates whether the User is Authenticated

 boolean

None.
UserInfo

Instance of the User Details. Null if the User is not Authenticated

 UserData

None.
AuthenticationToken

API authentication token for the User. Empty if the User is not Authenticated

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "IsAuthenticated": true,
  "UserInfo": {
    "SourceSystem": 0,
    "UserId": 1,
    "SourceReferenceId": "sample string 2",
    "Type": 0,
    "UserName": "sample string 3",
    "Password": "sample string 4",
    "FullName": "sample string 5 sample string 6",
    "FirstName": "sample string 5",
    "LastName": "sample string 6",
    "Email": "sample string 7",
    "AdditionalInfo": {},
    "Roles": {
      "1": [
        "sample string 1",
        "sample string 2"
      ],
      "2": [
        "sample string 1",
        "sample string 2"
      ]
    }
  },
  "AuthenticationToken": "sample string 2"
}

application/xml, text/xml

Sample: 
<AuthenticatedUserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.Base.WebAPI.Models">
  <AuthenticationToken>sample string 2</AuthenticationToken>
  <IsAuthenticated>true</IsAuthenticated>
  <UserInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/GBG.Base.WebAPI.Models.Security">
    <d2p1:AdditionalInfo />
    <d2p1:Email>sample string 7</d2p1:Email>
    <d2p1:FirstName>sample string 5</d2p1:FirstName>
    <d2p1:LastName>sample string 6</d2p1:LastName>
    <d2p1:Password>sample string 4</d2p1:Password>
    <d2p1:Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfintArrayOfstringty7Ep6D1>
        <d3p1:Key>1</d3p1:Key>
        <d3p1:Value>
          <d3p1:string>sample string 1</d3p1:string>
          <d3p1:string>sample string 2</d3p1:string>
        </d3p1:Value>
      </d3p1:KeyValueOfintArrayOfstringty7Ep6D1>
      <d3p1:KeyValueOfintArrayOfstringty7Ep6D1>
        <d3p1:Key>2</d3p1:Key>
        <d3p1:Value>
          <d3p1:string>sample string 1</d3p1:string>
          <d3p1:string>sample string 2</d3p1:string>
        </d3p1:Value>
      </d3p1:KeyValueOfintArrayOfstringty7Ep6D1>
    </d2p1:Roles>
    <d2p1:SourceReferenceId>sample string 2</d2p1:SourceReferenceId>
    <d2p1:SourceSystem>Local</d2p1:SourceSystem>
    <d2p1:Type>Other</d2p1:Type>
    <d2p1:UserId>1</d2p1:UserId>
    <d2p1:UserName>sample string 3</d2p1:UserName>
  </UserInfo>
</AuthenticatedUserModel>