POST /authentication_credentials

Submits authentication credentials to authenticate a user account. Credentials can either be passed in the HTTP Authorization header (in the format "user username:password") in which case the body can be omitted, or within a Credentials resource.

Note: This call is not rate-limited.

Parameters

(required)

Credentials resource containing the credentials for the authenticating user account.

callback

(optional)

Only available for JSON format. If supplied, the response will use JSONP format with a callback of the given name.

Request Content Type

application/json or application/xml

Response

Returns an authentication token if authentication succeeds. The client application should store the authentication token and submit it with subsequent API calls. The authentication token expires 30 minutes after it is last used. Returns '401 Unauthorized' and an error message if authentication fails.

Response Content Type

application/json, application/javascript (JSONP), application/xml or text/csv as requested

Request Examples

POST /authentication_credentials

JSON body:

{
  "Username": "me",
  "Password": "my_password"
}

XML body:

<?xml version="1.0"?>
<Credentials xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Username>me</Username>
  <Password>my_password</Password>
</Credentials>

Response Examples

JSON body:

"722fa0c702f42b68e2fdb771a80caed"

XML body:

<?xml version="1.0"?>
<string>722fa0c702f42b68e2fdb771a80caed</string>

CSV body:

722fa0c702f42b68e2fdb771a80caed