Casafari API and MCP Platform User Management Authentication API

openapi: 3.2.0
info:
  title: Casafari User Management Authentication API
  description: 'The Casafari API provides clients with methods for manipulating alerts feeds, accounts, and consulting a reference

    of available locations, features and conditions.


    # Authentication methods


    -->'
  version: 0.1.0
servers:
- url: https://api.casafari.com
tags:
- name: user-management---authentication
  x-displayName: Authentication
paths:
  /login:
    post:
      tags:
      - user-management---authentication
      summary: Login
      operationId: user-management__post__login
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserManagementLoginRequestSchema'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserManagementJWTTokenResponseSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserManagementHTTPValidationError'
  /refresh-token:
    get:
      tags:
      - user-management---authentication
      summary: Refresh Token
      operationId: user-management__get__refresh-token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserManagementJWTRefreshTokenResponseSchema'
      security:
      - HTTPBearer: []
components:
  schemas:
    UserManagementJWTTokenResponseSchema:
      properties:
        access_token:
          type: string
          title: Access Token
        refresh_token:
          type: string
          title: Refresh Token
      type: object
      required:
      - access_token
      - refresh_token
      title: JWTTokenResponseSchema
    UserManagementValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    UserManagementJWTRefreshTokenResponseSchema:
      properties:
        access_token:
          type: string
          title: Access Token
      type: object
      required:
      - access_token
      title: JWTRefreshTokenResponseSchema
    UserManagementLoginRequestSchema:
      properties:
        email:
          type: string
          title: Email
        password:
          type: string
          minLength: 1
          title: Password
      type: object
      required:
      - email
      - password
      title: LoginRequestSchema
    UserManagementHTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/UserManagementValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      description: '

        Sign in with your account: `POST /login` with your email and password returns an `access_token` and a

        `refresh_token`. Send the access token as `Authorization: Bearer <access_token>`. When it expires, call

        `GET /refresh-token` with `Authorization: Bearer <refresh_token>` for a new access token.

        '
      scheme: bearer
      bearerFormat: JWT
    OAuth2ClientCredentials:
      type: oauth2
      description: "**Recommended.** Create a client in Settings → API Clients and save its ID and secret. The secret is displayed only once, and the client can be used only in the environment where it was created.\n\nExchange the client ID and secret for an access token using HTTP Basic authentication:\n\n```bash\ncurl -X POST 'https://api.casafari.com/oauth/token' \\\n  -u 'CLIENT_ID:CLIENT_SECRET' \\\n  -d 'grant_type=client_credentials' \\\n  -d 'scope=api'\n```\n\nThe access token is valid for 30 minutes. No refresh token is issued, so you must request a new access token when the current one expires.\n\nInclude the access token in API requests using the following header:\n\n```\nAuthorization: Bearer <token>\n```"
      flows:
        clientCredentials:
          scopes:
            api: Access to the CASAFARI REST API.
          tokenUrl: https://api.casafari.com/oauth/token
x-tagGroups:
- name: User Management
  tags:
  - user-management---authentication
- name: API
  tags:
  - api---valuation
  - api---alerts
  - api---comparables
  - api---references
  - api---properties
- name: Market Analytics API
  tags:
  - market-analytics-api---time series
  - market-analytics-api---distributions
  - market-analytics-api---analysis
- name: Alerts API
  tags:
  - alerts-api---webhooks
  - alerts-api---feeds