Login

POST

/users/login

Parameters

Query Parameters

include

Related objects to include in the response. See the description of return value for more details.

Type

string

Format

"JSON"

Request Body

{

  

"username": "string",

  

"password": "string"

}

POST

/users/login

Request example

Responses

Body (JSON)

Content-Type

application/json

{

  

"id": "string",

  

"ttl": 1209600,

  

"scopes": [

  

  

"string"

  

],

  

"created": "string",

  

"userId": 0

}

Try this endpoint

Playground

Variables

Key

Value

include

Body

OpenAPI definition

References are expanded below, except recursive definitions and references with sibling fields. Documentation overrides are included. Full original OpenAPI spec (JSON).

View endpoint OpenAPI definition

openapi: 3.1.0
info:
  version: 1.1.0
  title: TrackingAPI
  description: V1 API for retrieving tracking data and changing settings on Lightbug devices
servers:
  - url: https://api.lightbug.cloud/api
externalDocs: {}
tags: []
paths:
  /users/login:
    post:
      tags:
        - authentication
      summary: Login
      parameters:
        - name: include
          in: query
          description: Related objects to include in the response. See the description of return value for more details.
          required: false
          schema:
            type: string
            format: JSON

requestBody:

        content:
          application/json:
            schema:
              properties:
                username:
                  type: string
                password:
                  type: string
              type: object
          application/x-www-form-urlencoded:
            schema:
              properties:
                username:
                  type: string
                password:
                  type: string
              type: object
          application/xml:
            schema:
              properties:
                username:
                  type: string
                password:
                  type: string
              type: object
          text/xml:
            schema:
              properties:
                username:
                  type: string
                password:
                  type: string
              type: object
        description: Body (JSON)
        required: true

      responses:

'200':

          description: Body (JSON)
          content:
            application/json:
              schema:
                properties:
                  id:
                    type: string
                  ttl:
                    default: 1209600
                    description: time to live in seconds (2 weeks by default)
                    type: number
                    format: ''
                  scopes:
                    description: Array of scopes granted to this access token.
                    type: array
                    items:
                      type: string
                  created:
                    type: string
                    format: date-time
                  userId:
                    type: number
                    format: ''
                required:
                  - id
                type: object

      deprecated: false
      operationId: post-users-login