openapi: 3.0.3
info:
  title: Security Awareness API Documentation Admin API
  description: This API documentation explains how to build your own AI powered security awareness and training application. HacWare is an AI-powered security awareness training and phishing simulation platform. This OpenAPI was derived by API Evangelist from HacWare's published apiDoc documentation.
  version: 1.0.4
  contact:
    name: HacWare
    email: hello@hacware.com
    url: https://hacware.com/dev.html
  termsOfService: https://hacware.com/terms-of-service
servers:
- url: https://{domain}
  description: Per-tenant HacWare API host; {domain} is the subdomain assigned to your company at onboarding.
  variables:
    domain:
      default: app.hacware.com
tags:
- name: Admin
paths:
  /api/v1/auth/:
    post:
      operationId: PostAPIAuth
      summary: API Auth
      description: Validates the secret key with the application id in order to generate the refresh and access tokens.
      tags:
      - Admin
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                appid:
                  type: string
                  description: Developer Application ID / APPID. This can be found in the developer dashboard. (Required)
                sec:
                  type: string
                  description: The Application secret key to gain access to the customer account. It is sent to the redirection_url in the add_customer endpoint. (Required)
              required:
              - appid
              - sec
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request. The error message describes the problem.
        '401':
          description: Unauthorized. Missing or invalid bearer token.
      security: []
  /api/dev/tier/status/:
    get:
      operationId: PostAPIStatus
      summary: API Status
      description: Provides a health status of the API.
      tags:
      - Admin
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request. The error message describes the problem.
        '401':
          description: Unauthorized. Missing or invalid bearer token.
      security:
      - bearerAuth: []
  /api/dev/tier/auth/:
    post:
      operationId: PostTieredAPIAuth
      summary: Tiered API Auth
      description: Validates the secret key to sign into API and generate the access tokens.
      tags:
      - Admin
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                appid:
                  type: string
                  description: Developer Application ID / APPID. This can be found in the developer dashboard. (Required)
                sec:
                  type: string
                  description: The Application secret key to gain access to the partner account information. (Required)
              required:
              - appid
              - sec
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request. The error message describes the problem.
        '401':
          description: Unauthorized. Missing or invalid bearer token.
      security: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer access token obtained from POST /api/v1/auth/ (exchange appid + secret key). Tokens expire ~1 hour after issue; use the refresh token to renew.
externalDocs:
  description: HacWare API Documentation
  url: https://www.hacware.com/doc/index.html