GET api/Authenticate?domain={domain}&username={username}&password={password}

Attempts a login to create an access token necessary to access protected resources.

Request Information

Parameters

NameDescriptionAdditional information
domain
The url of the provider

Define this parameter in the request URI.

username
The username

Define this parameter in the request URI.

password
The password

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "need_url": true,
  "error": {
    "error_message": "sample string 1"
  },
  "token": {
    "access_token": "sample string 1",
    "user_info": {
      "email_address": "sample string 1",
      "full_name": "sample string 2",
      "id": 3,
      "agent_id": 4
    }
  }
}

application/xml, text/xml

Sample:
<auth_result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ticket.Api.Auth">
  <error xmlns:d2p1="http://schemas.datacontract.org/2004/07/Ticket.Api">
    <d2p1:error_message>sample string 1</d2p1:error_message>
  </error>
  <need_url>true</need_url>
  <token>
    <access_token>sample string 1</access_token>
    <user_info xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ticket.Api.Org">
      <d3p1:agent_id>4</d3p1:agent_id>
      <d3p1:email_address>sample string 1</d3p1:email_address>
      <d3p1:full_name>sample string 2</d3p1:full_name>
      <d3p1:id>3</d3p1:id>
    </user_info>
  </token>
</auth_result>