POST api/v2.0/Authentication/Login

Generates a Authentication Token for the user with the specified credentials.

Request Information

URI Parameters

None.

Body Parameters

Username and Password for a user.

LoginCredentials
NameDescriptionTypeAdditional information
Username

Username of user logging in.

string

None.

Password

Password of user logging in.

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<LoginCredentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</LoginCredentials>

Response Information

Resource Description

Authentication Token.

AuthToken
NameDescriptionTypeAdditional information
Token

Encrypted Authentication String.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Token": "sample string 1"
}

application/xml, text/xml

Sample:
<AuthToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
  <Token>sample string 1</Token>
</AuthToken>