AsoBeast Auth API

openapi: 3.2.0
info:
  title: Asobeast Com Auth API
  x-refined-note:
  - x-authored-by differs across the merged source definitions and was not carried
  - x-engine differs across the merged source definitions and was not carried
  - x-evidence-tiers differs across the merged source definitions and was not carried
  - x-generated differs across the merged source definitions and was not carried
  - x-generated-from differs across the merged source definitions and was not carried
  - x-generator differs across the merged source definitions and was not carried
  - x-provenance differs across the merged source definitions and was not carried
  - x-sources differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Auth across 2 of this provider''s published API definitions: asobeast-com-openapi-generated.yml, asobeast-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:3000/api/backend
  description: Web origin proxy
- url: http://localhost:4000
  description: Direct API
tags:
- name: Auth
paths:
  /auth/login:
    post:
      operationId: post_auth_login
      tags:
      - Auth
      summary: Log in
      x-source: https://docs.asobeast.com/api-reference/auth/log-in
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAuthLoginRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
      security:
      - bearer: []
  /auth/logout:
    post:
      operationId: post_auth_logout
      tags:
      - Auth
      summary: Log out
      x-source: https://docs.asobeast.com/api-reference/auth/log-out
      responses:
        '204':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
      security:
      - bearer: []
  /auth/me:
    get:
      operationId: get_auth_me
      tags:
      - Auth
      summary: Returns authentication information about the current client, including…
      x-source: https://docs.asobeast.com/api-reference/rate-limits.md
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuthMeResponse'
      x-evidence:
        kind: documentation
      security:
      - bearer: []
  /auth/password:
    post:
      operationId: post_auth_password
      tags:
      - Auth
      summary: Change password and reset other sessions
      x-source: https://docs.asobeast.com/api-reference/auth/change-password-and-reset-other-sessions
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAuthPasswordRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
      security:
      - bearer: []
  /auth/password/forgot:
    post:
      operationId: post_auth_password_forgot
      tags:
      - Auth
      summary: Email a recovery link to an account that exists
      x-source: https://docs.asobeast.com/api-reference/auth/email-a-recovery-link-to-an-account-that-exists
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAuthPasswordForgotRequest'
      responses:
        '204':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
      security:
      - bearer: []
  /auth/plan:
    get:
      operationId: get_auth_plan
      tags:
      - Auth
      summary: Reports the AI calls usage for the workspace
      x-source: https://docs.asobeast.com/api-reference/rate-limits.md
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuthPlanResponse'
      x-evidence:
        kind: documentation
      security:
      - bearer: []
  /auth/register:
    post:
      operationId: post_auth_register
      tags:
      - Auth
      summary: Register an account
      x-source: https://docs.asobeast.com/api-reference/auth/register-an-account
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAuthRegisterRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
      security:
      - bearer: []
  /auth/tokens:
    post:
      operationId: post_auth_tokens
      tags:
      - Auth
      summary: Create a personal api token
      description: Create a personal api token for the authenticated user.
      x-source: https://docs.asobeast.com/api-reference/auth/create-a-personal-api-token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAuthTokensRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
      security:
      - bearer: []
    get:
      operationId: AuthController_listTokens
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      summary: List personal api tokens
      tags:
      - Auth
      security:
      - bearer: []
  /auth/tokens/{id}:
    delete:
      operationId: delete_auth_tokens_id
      tags:
      - Auth
      summary: Revoke a personal api token
      x-source: https://docs.asobeast.com/api-reference/auth/revoke-a-personal-api-token
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
      security:
      - bearer: []
  /auth/verify:
    post:
      operationId: post_auth_verify
      tags:
      - Auth
      summary: Confirm an email address and start the trial
      x-source: https://docs.asobeast.com/api-reference/auth/confirm-an-email-address-and-start-the-trial
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAuthVerifyRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
      security:
      - bearer: []
  /auth/verify/resend:
    post:
      operationId: AuthController_resendVerification
      parameters: []
      responses:
        '204':
          description: ''
      summary: Send a fresh confirmation link to this account
      tags:
      - Auth
      security:
      - personalApiToken: []
    servers:
    - url: http://localhost:3000/api/backend
      description: Web origin proxy
    - url: http://localhost:4000
      description: Direct API
  /auth/password/reset:
    post:
      operationId: AuthController_resetPassword
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetPasswordDto'
      responses:
        '204':
          description: ''
      summary: Redeem a recovery link and end every session
      tags:
      - Auth
      security:
      - personalApiToken: []
    servers:
    - url: http://localhost:3000/api/backend
      description: Web origin proxy
    - url: http://localhost:4000
      description: Direct API
  /auth/status:
    get:
      operationId: AuthController_status
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      summary: Public auth configuration and session state
      tags:
      - Auth
      security:
      - personalApiToken: []
    servers:
    - url: http://localhost:3000/api/backend
      description: Web origin proxy
    - url: http://localhost:4000
      description: Direct API
  /workspace/team:
    get:
      operationId: WorkspaceTeamController_list
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      summary: Members of this workspace and pending invites
      tags:
      - Auth
      security:
      - personalApiToken: []
    servers:
    - url: http://localhost:3000/api/backend
      description: Web origin proxy
    - url: http://localhost:4000
      description: Direct API
  /workspace/invites:
    post:
      operationId: WorkspaceTeamController_invite
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InviteMemberDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      summary: Invite a member into this workspace
      tags:
      - Auth
      security:
      - personalApiToken: []
    servers:
    - url: http://localhost:3000/api/backend
      description: Web origin proxy
    - url: http://localhost:4000
      description: Direct API
  /workspace/invites/{id}:
    delete:
      operationId: WorkspaceTeamController_revoke
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Revoke a pending invitation
      tags:
      - Auth
      security:
      - personalApiToken: []
    servers:
    - url: http://localhost:3000/api/backend
      description: Web origin proxy
    - url: http://localhost:4000
      description: Direct API
  /workspace/members/{id}:
    delete:
      operationId: WorkspaceTeamController_remove
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Remove a member from this workspace
      tags:
      - Auth
      security:
      - personalApiToken: []
    servers:
    - url: http://localhost:3000/api/backend
      description: Web origin proxy
    - url: http://localhost:4000
      description: Direct API
  /workspace/invites/accept:
    post:
      operationId: WorkspaceTeamController_accept
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AcceptInviteDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      summary: Accept an invitation and create the account
      tags:
      - Auth
      security:
      - personalApiToken: []
    servers:
    - url: http://localhost:3000/api/backend
      description: Web origin proxy
    - url: http://localhost:4000
      description: Direct API
components:
  schemas:
    PostAuthPasswordRequest:
      type: object
      properties:
        next:
          type: string
          description: 'Password must contain at least 10 characters that are not whitespace. Required string length: 10 - 128'
        current:
          type: string
          description: 'Maximum string length: 128'
      required:
      - next
      - current
    PostAuthLoginRequest:
      type: object
      properties:
        email:
          type: string
        password:
          type: string
          description: 'Maximum string length: 128'
      required:
      - email
      - password
    GetAuthPlanResponse:
      type: object
      properties:
        usage.aiCalls:
          type: integer
          description: Number of AI calls used by the workspace.
    PostAuthVerifyRequest:
      type: object
      properties:
        token:
          type: string
          description: 'Required string length: 16 - 128'
      required:
      - token
    PostAuthPasswordForgotRequest:
      type: object
      properties:
        email:
          type: string
          description: Email address of the account to recover
      required:
      - email
    PostAuthRegisterRequest:
      type: object
      properties:
        password:
          type: string
          description: 'Password must contain at least 10 characters that are not whitespace. Required string length: 10 - 128'
        email:
          type: string
        name:
          type: string
          description: 'Maximum string length: 120'
      required:
      - password
      - email
      - name
    PostAuthTokensRequest:
      type: object
      properties:
        name:
          type: string
          description: 'Required string length: 1 - 120'
        scope:
          type: string
          description: 'Enum, default: read. Available options: read, write'
        expiresInDays:
          type: number
          description: 'Required range: 1 <= x <= 365'
      required:
      - name
      - expiresInDays
    GetAuthMeResponse:
      type: object
      properties:
        suspendedAt:
          type: string
          description: Timestamp when the workspace was suspended, if applicable.
        suspendedReason:
          type: string
          description: Reason for suspension, if applicable.
    AcceptInviteDto:
      type: object
      properties:
        password:
          type: string
          minLength: 10
          maxLength: 128
          description: Password must contain at least 10 characters that are not whitespace.
        token:
          type: string
          minLength: 16
          maxLength: 128
        name:
          type: string
          maxLength: 120
      required:
      - password
      - token
    ChangePasswordDto:
      type: object
      properties:
        next:
          type: string
          minLength: 10
          maxLength: 128
          description: Password must contain at least 10 characters that are not whitespace.
        current:
          type: string
          maxLength: 128
      required:
      - next
      - current
    CreateTokenDto:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 120
        scope:
          enum:
          - read
          - write
          type: string
          default: read
        expiresInDays:
          type: number
          minimum: 1
          maximum: 365
      required:
      - name
    InviteMemberDto:
      type: object
      properties:
        email:
          type: string
          format: email
      required:
      - email
    RequestPasswordResetDto:
      type: object
      properties:
        email:
          type: string
          maxLength: 320
          format: email
      required:
      - email
    ResetPasswordDto:
      type: object
      properties:
        password:
          type: string
          minLength: 10
          maxLength: 128
          description: Password must contain at least 10 characters that are not whitespace.
        token:
          type: string
          minLength: 16
          maxLength: 128
      required:
      - password
      - token
    RegisterDto:
      type: object
      properties:
        password:
          type: string
          minLength: 10
          maxLength: 128
          description: Password must contain at least 10 characters that are not whitespace.
        email:
          type: string
          format: email
        name:
          type: string
          maxLength: 120
      required:
      - password
      - email
    VerifyEmailDto:
      type: object
      properties:
        token:
          type: string
          minLength: 16
          maxLength: 128
      required:
      - token
    LoginDto:
      type: object
      properties:
        email:
          type: string
          format: email
        password:
          type: string
          maxLength: 128
      required:
      - email
      - password
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
    personalApiToken:
      scheme: bearer
      bearerFormat: asob
      type: http
x-refined-from:
- asobeast-com-openapi-generated.yml
- asobeast-com-openapi.json