authentication

Summary

Resource	Operation	Description
	GET /api/app/v1/login	Authentication
Authentication	GET /api/app/v1/form_token	Get form token
	GET /api/app/v1/upgrade/form_token
	GET /api/app/v1/hotfix/form_token
	PUT /api/app/v1/login	Get authentication token

Details

GET /api/app/v1/form_token

GET /api/app/v1/upgrade/form_token

GET /api/app/v1/hotfix/form_token

Get a form token. Form uploads cannot have their headers modified. This method will generate a very short timed token that is tied to the IP of the requester. It must come in as a parameter for an upload.

Note

Username/password is sent with the -u option with curl for Basic Auth.

Response Headers:  

• Content-Type – application/json

Status Codes:

• 200 OK – Successful Login
• 401 Unauthorized – Unsuccessful Login

Example 1 - Valid Request: Get form token:

GET /api/app/v1/form_token HTTP/1.1
Accept: text/html

Example 1 - Valid Response: Get form token:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "token": "<FORM_TOKEN>"
}

PUT /api/app/v1/login

Generate an API authentication token.

Note

Username/password is sent with the -u option with curl for Basic Auth.

Response Headers:  

• Content-Type – application/json

Status Codes:

• 200 OK – Successful Login
• 403 Forbidden – Unsuccessful Login

Example 1 - Valid Request: Correct username/password:

GET /api/app/v1/login HTTP/1.1
Accept: text/html

Example 1 - Valid Response: Correct username/password:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "token": "<AUTH_TOKEN>"
}

Example 2 - Invalid Request: Incorrect username/password:

GET /api/app/v1/login HTTP/1.1
Accept: text/html

Example 2 - Invalid Response: Incorrect username/password:

HTTP/1.1 403 OK
Content-Type: text/html

Unauthorized Access

GET /api/app/v1/login

Verify API login credentials

Note

Username/password is sent with the -u option with curl for Basic Auth.

Response Headers:  

• Content-Type – application/json

Status Codes:

• 200 OK – Successful Login
• 401 Unauthorized – Unsuccessful Login

Example 1 - Valid Request: Correct username/password:

GET /api/app/v1/login HTTP/1.1
Accept: text/html

Example 1 - Valid Response: Correct username/password:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Login": "true"
}

Example 2 - Invalid Request: Incorrect username/password:

GET /api/app/v1/login HTTP/1.1
Accept: text/html

Example 2 - Invalid Response: Incorrect username/password:

HTTP/1.1 401 OK
Content-Type: text/html

Unauthorized Access