POST 1.0/Security/AuthenticateCredentials

Authenticates the passed in credentials, returning a list of related Instance objects if successful

Request Information

URI Parameters

None.

Body Parameters

AuthenticateCredentialsRequest object containing user name and password to authenticate

AuthenticateCredentialsRequest
API Parameter Details
NameDescriptionTypeAdditional information
Username

The username portion of the credentials to be authenticated

string

None.

Password

The password portion of the credentials to be authenticated

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Username": "sample string 1",
  "Password": "sample string 2"
}

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 'AuthenticateCredentialsRequest'.

Response Information

Resource Description

AuthenticateResponse
API Parameter Details
NameDescriptionTypeAdditional information
Instances

A list of Instance objects relevant to a login

Collection of Instance

None.

Response Formats

application/json, text/json

Sample:
{
  "Instances": [
    {
      "Id": "sample string 1",
      "Url": "sample string 2",
      "Name": "sample string 3",
      "Ticket": "sample string 4",
      "SharedSecret": "sample string 5"
    },
    {
      "Id": "sample string 1",
      "Url": "sample string 2",
      "Name": "sample string 3",
      "Ticket": "sample string 4",
      "SharedSecret": "sample string 5"
    }
  ]
}