openapi: 3.0.1
info:
  title: Organization APIs
  description: >-
    Organization APIs provide access to specific operations designed to act against platform organization.
  version: v1
servers:
  - url: 'https://api.{env}.{tenant}.lenushealth.dev/organizations/v1'
    variables:
      env:
        default: test
        enum:
          - test
          - sbx
      tenant:
        default: ggc
        enum:
          - ggc
        description: 'Available tenants'
paths:
  /membership:
    get:
      summary: Retrieve Organizational Memberships for authenticated user
      description: Returns a list of organizations to which the authenticated user is associated
      operationId: organization-membership-v1
      security:
        - bearer: []
      responses:
        '200':
          description: 'Returns an array of objects listing each organization the authenticated user is an agent within'
          content:
            application/json:
              schema:
                type: array
                items:
                  minItems: 0
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                      title: unique identifier for a given organization
                    name:
                      type: string
                      example: 'Organization #1'
                      title: The name associated with the organization
        '401':
          description: 'The `access_token` is not valid, this maybe due to expiration or invalid audience of issuer'
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT