HHS (US Department of Health and Human Services) LOCAL ONLY API

openapi: 3.1.0
info:
  description: '

    Back end API for simpler.grants.gov.


    This API is in active development as we build out new functionalities for Simpler.Grants.gov. It is currently stable for everyday use, and will be versioned with advance notice for any breaking changes.


    Learn more in our [API documentation](https://wiki.simpler.grants.gov/product/api).

    See [Release Phases](https://github.com/github/roadmap?tab=readme-ov-file#release-phases) for further details.

    '
  contact:
    name: Simpler Grants.gov
    url: https://simpler.grants.gov/
    email: simpler@grants.gov
  title: Simpler Grants LOCAL ONLY API
  version: v0
servers: .
tags:
- name: LOCAL ONLY
paths:
  /local/local-users:
    get:
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalUserTokenResponseSchema'
          description: Successful response
      tags:
      - LOCAL ONLY
      summary: Local Users Get
components:
  schemas:
    LocalUserTokenSchema:
      type: object
      properties:
        user_id:
          type: string
          format: uuid
          description: The ID of the user
          example: 123e4567-e89b-12d3-a456-426614174000
        first_name:
          type: string
          description: The first name of the user
          example: Bob
        last_name:
          type: string
          description: The last name of the user
          example: Smith
        oauth_id:
          type: string
          description: The OAuth id of the user - can be used to login locally via our mock OAuth server
          example: my_example_user
        user_jwt:
          type: string
          description: The JWT of the user, can be used with our X-SGG-Token auth
          example: abc123
        user_api_key:
          type: string
          description: The API key of the user, can be used with our X-API-Key auth
          example: my_example_user_token
    LocalUserTokenResponseSchema:
      type: object
      properties:
        message:
          type: string
          description: The message to return
          example: Success
        data:
          type: array
          items:
            type:
            - object
            $ref: '#/components/schemas/LocalUserTokenSchema'
        status_code:
          type: integer
          description: The HTTP status code
          example: 200
  securitySchemes:
    ApiJwtAuth:
      type: apiKey
      in: header
      name: X-SGG-Token
    InternalApiJwtAuth:
      type: apiKey
      in: header
      name: X-SGG-Internal-Token
    ApiUserKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key