POST Token

Use this method to authenticate and get a token to access the functions of this API. This method follows the OAuth2 Bearer Token standards

Request Information

URI Parameters

None.

Body Parameters

The authentication request information required to get a Bearer Token

Name	Description	Type	Additional information
UserName	User name to attempt to authenticate to the service with	string	Required
Password	The password for the user	string	Required
Client_Id	The Client Id is the App Id of the Provider that is authorized to use this service	globally unique identifier	Required
Client_Secret	The Client Secret is the Secret Key of the Provider that is authorized to use this service. This is provided one time upon creating the provider and should remain secret	globally unique identifier	Required
Grant_Type	The type of grant you're requesting. Under normal use this should be "password"	string	Required

Request Formats

application/json, text/json

Sample:

{
  "userName": "email@domain.com",
  "password": "the user password",
  "client_Id": "8aa2cf1f-4217-4254-9bc3-501a6d268eed",
  "client_Secret": "b3b9e430-3b34-4114-b248-4d5d7ec7b768",
  "grant_Type": "password"
}

application/x-www-form-urlencoded

Sample:

userName=email@domain.com&password=theUserPassword&client_Id=8aa2cf1f-4217-4254-9bc3-501a6d268eed&client_Secret=b3b9e430-3b34-4114-b248-4d5d7ec7b768&grant_Type=password

Response Information

Resource Description

The token information, if successful

Name	Description	Type	Additional information
access_token	The access token to use in your Authorization header in subsequent requests to the API	string	Required
expires_in	Amount of seconds from the token issued time before the token will expire	int	Required
userName	The user name the token is for	string	Required
.issued	The date and time the token was issued	datetime	Required
.expires	The date and time the token will expire	datetime	Required

Response Formats

application/json, text/json

Sample:

{
  "access_token": "random token abcd123",
  "token_type": "bearer",
  "expires_in": 1209599,
  "userName": "email@domain.com",
  ".issued": "Fri, 06 Mar 2015 19:04:36 GMT",
  ".expires": "Fri, 20 Mar 2015 19:04:36 GMT"
}