POST v1/authenticate/apipassword?email={email}

Authenticates the supplied ApiPassword and returns an access token.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
email

Email address of the account.

string

Required

Body Parameters

ApiPassword of the account.

string

Request Formats

application/json, text/json

Sample:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'String'.

Response Information

Resource Description

An access token that can be used to authenticate further calls to the api.

BaseReturn
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<BaseReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Greenvelope.Shared">
  <Message>sample string 2</Message>
  <Success>true</Success>
</BaseReturn>