AUTHENTICATION.md

Authentication

Authentication allows you create and delete tokens.

Table of Contents

• Generate Token
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body
    • Response Examples
• Delete Token
  • Headers
  • Path Parameters
  • Query Parameters
  • Request Body
  • Response
    • Status Code
    • Response Body

Generate Token

Generates token.

POST /api/tokens

Headers

None.

Path Parameters

None.

Query Parameters

None.

Request Body

Body must be x-www-form-urlencoded.

• username (string, required) - Name of the user.
• password (string, required) - Password of the user.

username: guacadmin
password: guacadmin

Response

Status Code

• 200 - OK

Response Body

Returns a JSON object.

• authToken (string) - Auth token.
• username (string) - Username.
• dataSource (string) - Datasource.
• availableDatasources (array) - List of available data sources.

Response Examples

{
  "authToken": "0BDA2CED0580DEB052C34B596AB401993BFD66551FADEF06FC7144F1D6318EE8",
  "username": "guacadmin",
  "dataSource": "postgresql",
  "availableDataSources": ["postgresql", "postgresql-shared"]
}

---

Delete Token

Deletes token.

DELETE /api/tokens/{{token}}

Headers

None.

Path Parameters

• token (string, required) - Auth Token

Query Parameters

None.

Request Body

None.

Response

Status Code

• 204 - No Content

Response Body

This request does not return a response body.

---

Back to Top