TruVideo Authentication API

The Authentication API from TruVideo — 2 operation(s) for authentication.

OpenAPI Specification

truvideo-authentication-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: TruVideo Platform Authentication API
  version: v2
  description: 'REST API for the TruVideo omnichannel video-and-messaging platform for service businesses (built for the automotive service market: dealers, service advisors, technicians, repair orders and customers). Covers authentication, users, dealers, repair orders, videos, messaging conversations, customers, files, in-app chat, reporting and support. Faithfully reconstructed from TruVideo''s published API documentation (github.com/Truvideo/Documentation); TruVideo does not publish a machine readable OpenAPI definition of its own.'
  contact:
    name: TruVideo Developer Team
    email: devmgr+git@truvideo.com
    url: https://truvideo.com/software-partnerships/
  x-generated-by: api-evangelist-enrichment
  x-source: https://github.com/Truvideo/Documentation
servers:
- url: https://app.truvideo.com
  description: Production
- url: https://dev.truvideo.com
  description: Sandbox / test (requires a TruVideo Sandbox account; may be gated)
security:
- bearerAuth: []
tags:
- name: Authentication
paths:
  /api/v2/authentication/login:
    post:
      tags:
      - Authentication
      operationId: authLogin
      summary: Login
      description: Logs the user into the system and returns a JWT access token for the passed credentials.
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - email
              - password
              properties:
                email:
                  type: string
                  format: email
                password:
                  type: string
                  format: password
      responses:
        '200':
          description: Access token issued
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
                    description: JWT bearer token
        '401':
          description: Invalid credentials
  /api/v2/authentication/logout:
    post:
      tags:
      - Authentication
      operationId: authLogout
      summary: Logout
      description: Logs the user out of the system. Empty request and response body. Authorization header must be present.
      responses:
        '200':
          description: Logged out
        '401':
          description: Missing or invalid token
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT bearer token obtained from POST /api/v2/authentication/login.