XaitCPQ API

POST account/login

Perform a login to get an access token for API access.

Request Information

URI

https://ofd-api.blueprintcpq.net/account/login

URI Parameters

None.

Body Parameters

Change password options.

LoginViewModel
NameDescriptionTypeAdditional information
Grant_Type

string

None.
Username

string

None.
Password

string

None.

Request Formats

application/json, text/json

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

text/html

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

application/xml, text/xml

Sample: 
<LoginViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.AccountViewModels">
  <Grant_Type>sample string 1</Grant_Type>
  <Password>sample string 3</Password>
  <Username>sample string 2</Username>
</LoginViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A LoginViewModel.

LoginResult
NameDescriptionTypeAdditional information
Access_Token

Gets or sets the access token.

 string

None.
Token_Type

Gets or sets the type of the token.

 string

None.
Expires_In

Gets or sets the expires in.

 integer

None.
Username

Gets or sets the username.

 string

None.
Id

Gets or sets the identifier.

 globally unique identifier

None.
FirstName

Gets or sets the person's first name.

 string

None.
LastName

Gets or sets the person's last name.

 string

None.
Issued

Gets or sets the issued.

 string

None.
Expires

Gets or sets the expires.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Access_Token": "sample string 1",
  "Token_Type": "sample string 2",
  "Expires_In": 3,
  "Username": "sample string 4",
  "Id": "b16dcb4a-a44d-4d27-b831-3d533017c656",
  "FirstName": "sample string 6",
  "LastName": "sample string 7",
  "Issued": "sample string 8",
  "Expires": "sample string 9"
}

text/html

Sample: 
{"Access_Token":"sample string 1","Token_Type":"sample string 2","Expires_In":3,"Username":"sample string 4","Id":"b16dcb4a-a44d-4d27-b831-3d533017c656","FirstName":"sample string 6","LastName":"sample string 7","Issued":"sample string 8","Expires":"sample string 9"}

application/xml, text/xml

Sample: 
<LoginResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Results">
  <Access_Token>sample string 1</Access_Token>
  <Expires>sample string 9</Expires>
  <Expires_In>3</Expires_In>
  <FirstName>sample string 6</FirstName>
  <Id>b16dcb4a-a44d-4d27-b831-3d533017c656</Id>
  <Issued>sample string 8</Issued>
  <LastName>sample string 7</LastName>
  <Token_Type>sample string 2</Token_Type>
  <Username>sample string 4</Username>
</LoginResult>