Api

post

Takes a set of user credentials and returns an access and refresh JSON web token pair to prove the authentication of those credentials.

Authorizations
Body
usernamestring · min: 1Required
passwordstring · min: 1Required
Responses
201Success
application/json
post
POST /api/auth/jwt/ HTTP/1.1
Host: app.timbr.studio
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "username": "text",
  "password": "text"
}
201Success
{
  "username": "text",
  "password": "text"
}
post

Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.

Authorizations
Body
refreshstring · min: 1Required
accessstring · min: 1Read-onlyOptional
Responses
201Success
application/json
post
POST /api/auth/jwt/refresh/ HTTP/1.1
Host: app.timbr.studio
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "refresh": "text"
}
201Success
{
  "refresh": "text",
  "access": "text"
}
post

Takes a token and indicates if it is valid. This view provides no information about a token's fitness for a particular use.

Authorizations
Body
tokenstring · min: 1Required
Responses
201Success
application/json
post
POST /api/auth/jwt/verify/ HTTP/1.1
Host: app.timbr.studio
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "token": "text"
}
201Success
{
  "token": "text"
}
get

List all API tokens for the authenticated user

Authorizations
Path parameters
team_uuidstringRequired
Responses
200Success
application/json
get
GET /api/openapi/token/{team_uuid}/ HTTP/1.1
Host: app.timbr.studio
Authorization: Bearer YOUR_API_KEY
Accept: */*
{
  "tokens": [
    {
      "access_token": "text",
      "token_issuer_uuid": "text",
      "created_at": "text",
      "updated_at": "text",
      "expires_at": "text"
    }
  ]
}
post

Issue a new API token

Authorizations
Path parameters
team_uuidstringRequired
Responses
200Success
application/json
post
POST /api/openapi/token/{team_uuid}/ HTTP/1.1
Host: app.timbr.studio
Authorization: Bearer YOUR_API_KEY
Accept: */*
{
  "access_token": "text",
  "token_issuer_uuid": "text",
  "created_at": "text",
  "updated_at": "text",
  "expires_at": "text"
}
post

Delete API tokens

Authorizations
Path parameters
team_uuidstringRequired
Responses
200Success
application/json
post
POST /api/openapi/token/{team_uuid}/delete/ HTTP/1.1
Host: app.timbr.studio
Authorization: Bearer YOUR_API_KEY
Accept: */*
{
  "requested_count": 1,
  "deleted_count": 1
}