Cover Whale Authentication API

openapi: 3.2.0
info:
  title: Coverwhaleinsurancesolutions Authentication API
  version: '1.0'
  contact:
    name: Cover Whale API Team
  description: 'Operations tagged Authentication across 2 of this provider''s published API definitions: coverwhaleinsurancesolutions-openapi.json, coverwhaleinsurancesolutions-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.coverwhale.dev/v1
security:
- AccessToken: []
tags:
- name: Authentication
  description: Authenticating & Interacting with the API
paths:
  /health:
    get:
      tags:
      - Authentication
      summary: Check API Health
      description: Simple, unauthenticated health probe. Confirms the API service is reachable and its database connection is up. No `AccessToken` is required — use this to smoke-test connectivity before authenticating.
      operationId: getHealth
      responses:
        '200':
          description: API is healthy. Returns a JSON array containing a single status string.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                example:
                - CoverWhale API Reached
        '400':
          description: API is reachable but a downstream dependency (e.g. database) is unavailable. Returns a plain JSON string.
          content:
            application/json:
              schema:
                type: string
                example: CoverWhale API Reached
    servers:
    - url: https://api.coverwhale.dev/v1
  /authentication:
    post:
      tags:
      - Authentication
      summary: Get Authentication Token
      description: Request an authentication and refresh token with user credentials
      operationId: authentication
      parameters:
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        example: application/json
      - name: Accept
        in: header
        required: true
        schema:
          type: string
        example: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - username
              - password
              properties:
                username:
                  type: string
                  example: j.doe@coverwhale.com
                password:
                  description: provided user password. Password reset can be used to recover account.
                  type: string
                new_password:
                  type: string
                refresh_token:
                  description: Can be combined with username to generate new AccessTokens.
                  type: string
              type: object
      responses:
        '200':
          description: Authentication Success
          content:
            application/json:
              schema:
                properties:
                  AccessToken:
                    description: Access Token, used for API calls.
                    type: string
                  RefreshToken:
                    description: Refresh Token, used for re-authentication.
                    type: string
                  ExpiresIn:
                    description: Halflife for active AccessToken.
                    type: integer
                    example: '3600'
                type: object
        '400':
          description: Authentication Error
          content:
            application/json:
              schema:
                properties:
                  Error:
                    description: Auth Error, bad username or password. If password expired please use reset enpoint.
                    type: string
                    example: 'Auth Error: Incorrect username or password.'
                type: object
    servers:
    - url: https://api.coverwhale.dev/v1
  /password-reset:
    get:
      tags:
      - Authentication
      summary: Get a password reset Token
      description: Request a password reset token for the provide username. The reset token will be emailed to the username/email if found.
      operationId: getPasswordReset
      parameters:
      - name: username
        in: query
        required: true
        schema:
          type: string
        example: api_user
      responses:
        '200':
          description: Authentication Success
          content:
            application/json:
              example: 'Auth Success: Password Reset Initiated. Please Execute POST with provided reset code.'
              schema:
                type: string
        '400':
          description: Authentication Error
          content:
            application/json:
              example: 'Auth Error: User does not exist.'
              schema:
                type: string
    post:
      tags:
      - Authentication
      summary: Reset Password with Token
      description: Reset the password of associated username with provided reset token. Reset token is emailed to username/email if found from GET endpoint.
      operationId: postPasswordReset
      parameters:
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        example: application/json
      - name: Accept
        in: header
        required: true
        schema:
          type: string
        example: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - username
              - new_password
              - reset_token
              properties:
                username:
                  type: string
                  example: j.doe@coverwhale.com
                new_password:
                  description: New password for associated username.
                  type: string
                reset_token:
                  description: Reset token emailed to associated username.
                  type: string
              type: object
      responses:
        '200':
          description: Authentication Success
          content:
            application/json:
              example: 'Auth Success: Password Reset Success.'
              schema:
                type: string
        '400':
          description: Authentication Error
          content:
            application/json:
              example: 'Auth Error: Password Reset Failed; Invalid verification code provided, please try again..'
              schema:
                type: string
    servers:
    - url: https://api.coverwhale.dev/v1
components:
  securitySchemes:
    AccessToken:
      type: apiKey
      description: JWT returned as AccessToken by the /authentication endpoint (the Cognito ID token carrying the email claim). It expires after 3600 seconds.
      name: AccessToken
      in: header
x-refined-from:
- coverwhaleinsurancesolutions-openapi.json
- coverwhaleinsurancesolutions-openapi.json