API

Auth

Sections

Obtain Auth Tokens

Description

Accepts user credentials and returns access and refresh tokens

URL

/api/v1/auth_token/

HTTP Method

POST

Path Parameters

None

Query Parameters

None

Data Parameters

  • username (String): required
  • password (String): required

Request Headers

  • Content-Type: application/json

Response

  • Status Code: 200
  • Content-Type: application/json
  • Schema/Example:
{
  "data": {
    "refresh": "[REDACTED]",
    "access": "[REDACTED]"
  },
  "error": false,
  "errcode": 0,
  "errmsg": null,
  "status": 200
}

Refresh Auth Tokens

Description

Accepts refresh token and returns a new pair of access and refresh tokens

URL

/api/v1/auth_token_refresh/

HTTP Method

POST

Path Parameters

None

Query Parameters

None

Data Parameters

  • refresh (String): a valid refresh token (required)

Request Headers

  • Content-Type: application/json

Response

  • Status Code: 200
  • Content-Type: application/json
  • Schema/Example:
{
  "data": {
    "access": "[REDACTED]",
    "refresh": "[REDACTED]"
  },
  "error": false,
  "errcode": 0,
  "errmsg": null,
  "status": 200
}
Selection