POST Authenticate

The API is secured using the OAuth 2.0 standard. First, the consumer sends their username and password to the authentication page. If authenticated, they will receive an access token in the response.The access token must be sent on all subsequent requests.

Request Information

URI Parameters

None.

Body Parameters

Type: string
NameDescriptionTypeAdditional information
username

The username to authenticate

string

None.

password

The password associated with the username

string

None.

grant_type

The authentication type (always set to 'password')

string

None.

Request Formats

application/x-www-form-urlencoded

Sample:
username=jsmith&password=abc1234&grant_type=password

Response Information

Resource Description

Returns the authentication ticket.

Type: AuthorizationTicketModel
NameDescriptionTypeAdditional information
access_token

The access token.

string

None.

token_type

The type of the token.

string

None.

expires_in

The expiration time in seconds.

integer

None.

apiVersionNumber

The API's version number.

string

None.

userName

The username.

string

None.

householdNumber

The household number.

string

None.

.issued

The date the token was issued.

date

None.

.expires

The expiration date.

date

None.

IsValid

Indicates if the authorization is valid or not.

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "access_token": "gBsdjflsdkj#wsjelKDSDdsdDTjeYYfvikg2cZQIu_ombqpyE7DZgEHClLO06EtHLFV65lelXVwx9JR33gib3nxzzJKLSDFJ-Xrt5ressxjArc3F6hy1J...",
  "token_type": "bearer",
  "expires_in": 0,
  "apiVersionNumber": "1.0.0.0",
  "userName": "jsmith",
  "householdNumber": "1000",
  ".issued": "2018-11-18T21:41:59.3251152-05:00",
  ".expires": "2018-11-18T21:42:59.3251152-05:00",
  "IsValid": false
}