4chems Invitations API

openapi: 3.2.0
info:
  title: platform-api Invitations API
  description: 'Platform API: infrastructure, operational, and customer tiers.'
  version: 0.12.1
tags:
- name: Invitations
paths:
  /v1/tenant/invitations:
    post:
      tags:
      - Invitations
      summary: Create Invitation
      description: 'Invite an email address to the caller''s tenant at the specified access

        level and return the invitation, including the raw single-use accept

        token. Call this when a tenant admin wants to add a new member; the

        invitee accepts via `accept_invitation`.'
      operationId: create_invitation
      security:
      - HTTPBearer: []
      parameters:
      - name: tenant_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Tenant Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvitationIn'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitationCreatedOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-destructive: false
      x-idempotent: false
    get:
      tags:
      - Invitations
      summary: List Invitations
      description: 'List all invitations for the caller''s tenant, most recent first. Call this to

        show a tenant admin which invitations are pending, accepted, or revoked; the

        raw token is never included.'
      operationId: list_invitations
      security:
      - HTTPBearer: []
      parameters:
      - name: tenant_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Tenant Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InvitationOut'
                title: Response List Invitations
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/tenant/invitations/{invitation_id}:
    delete:
      tags:
      - Invitations
      summary: Revoke Invitation
      description: 'Revoke a pending invitation so its token can no longer be accepted. Call this

        when a tenant admin wants to withdraw an invite sent by mistake or no longer

        needed; accepted invitations cannot be revoked.'
      operationId: revoke_invitation
      security:
      - HTTPBearer: []
      parameters:
      - name: invitation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Invitation Id
      - name: tenant_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Tenant Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-destructive: true
      x-idempotent: true
  /v1/invitations/{token}/accept:
    post:
      tags:
      - Invitations
      summary: Accept Invitation
      description: 'Accept a pending invitation and grant the invitee''s first role assignment.

        Call this when an invitee has a valid invite link and wants to join the

        tenant; single-use, consuming the token marks it accepted.


        The caller must be authenticated (CUSTOMER role) so their KC subject is

        recorded in the new role_assignment. No scope pre-condition is required.'
      operationId: accept_invitation
      security:
      - HTTPBearer: []
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitationOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-destructive: false
      x-idempotent: false
components:
  schemas:
    ValidationError:
      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
    InvitationOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        tenant_id:
          type: string
          title: Tenant Id
        email:
          type: string
          title: Email
        level:
          type: string
          title: Level
        billing_contact:
          type: boolean
          title: Billing Contact
          default: false
        status:
          type: string
          title: Status
        expires_at:
          type: string
          format: date-time
          title: Expires At
        invited_by:
          type: string
          title: Invited By
        created_at:
          type: string
          format: date-time
          title: Created At
        accepted_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Accepted At
      type: object
      required:
      - id
      - tenant_id
      - email
      - level
      - status
      - expires_at
      - invited_by
      - created_at
      title: InvitationOut
    Role:
      type: string
      enum:
      - viewer
      - member
      - admin
      - owner
      title: Role
      description: 'The grantable tenant access levels (ADR 0016 decision 3: role collapse).


        Scoped department/instance roles (``team_admin``, ``env_admin``,

        ``app_admin``, ``application_owner``, ``application_supervisor``,

        ``application_user``) and the platform roles (``platform_admin``,

        ``node_admin``) are no longer grantable; the migration

        (``uc087accesslevelscore_0001``) maps every existing row onto one of

        these four values.'
    InvitationCreatedOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        tenant_id:
          type: string
          title: Tenant Id
        email:
          type: string
          title: Email
        level:
          type: string
          title: Level
        billing_contact:
          type: boolean
          title: Billing Contact
          default: false
        status:
          type: string
          title: Status
        expires_at:
          type: string
          format: date-time
          title: Expires At
        invited_by:
          type: string
          title: Invited By
        created_at:
          type: string
          format: date-time
          title: Created At
        accepted_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Accepted At
        token:
          type: string
          title: Token
      type: object
      required:
      - id
      - tenant_id
      - email
      - level
      - status
      - expires_at
      - invited_by
      - created_at
      - token
      title: InvitationCreatedOut
      description: Returned only on POST — includes the raw token for sharing the invite link.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    InvitationIn:
      properties:
        email:
          type: string
          format: email
          title: Email
        level:
          $ref: '#/components/schemas/Role'
          default: viewer
        billing_contact:
          type: boolean
          title: Billing Contact
          default: false
      type: object
      required:
      - email
      title: InvitationIn
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer