POST v1/system/login

Log ins to Circle. Generates a new security token.

Request Information

URI Parameters

None.

Body Parameters

The login details.

LoginModel
NameDescriptionTypeAdditional information
UserName

Gets the login user name.

string

None.

UserPassword

Gets the login user password.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "UserName": "sample string 1",
  "UserPassword": "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 'LoginModel'.

Response Information

Resource Description

Returns a generated security token.

StringModel
NameDescriptionTypeAdditional information
Value

Gets the string value.

string

None.

Response Formats

application/json, text/json

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