SuperTokens Core Driver Interface — Sessions

naftiko: 1.0.0-alpha2
info:
  label: SuperTokens Core Driver Interface — Sessions
  description: 'SuperTokens Core Driver Interface — Sessions. 6 operations. Lead operation: Create Session. Self-contained
    Naftiko capability covering one Supertokens business surface.'
  tags:
  - Supertokens
  - Sessions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SUPERTOKENS_API_KEY: SUPERTOKENS_API_KEY
capability:
  consumes:
  - type: http
    namespace: core-driver-interface-sessions
    baseUri: http://{host}:{port}
    description: SuperTokens Core Driver Interface — Sessions business capability. Self-contained, no shared references.
    resources:
    - name: recipe-session
      path: /recipe/session
      operations:
      - name: createsession
        method: POST
        description: Create Session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getsession
        method: GET
        description: Get Session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accessToken
          in: query
          type: string
          description: The access token to verify
          required: true
        - name: doAntiCsrfCheck
          in: query
          type: boolean
          description: Whether to perform anti-CSRF check
    - name: recipe-session-data
      path: /recipe/session/data
      operations:
      - name: getsessiondata
        method: GET
        description: Get Session Data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sessionHandle
          in: query
          type: string
          description: The session handle to retrieve data for
          required: true
      - name: updatesessiondata
        method: PUT
        description: Update Session Data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: recipe-session-refresh
      path: /recipe/session/refresh
      operations:
      - name: refreshsession
        method: POST
        description: Refresh Session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: recipe-session-remove
      path: /recipe/session/remove
      operations:
      - name: removesessions
        method: POST
        description: Remove Sessions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: api-key
      value: '{{env.SUPERTOKENS_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: core-driver-interface-sessions-rest
    port: 8080
    description: REST adapter for SuperTokens Core Driver Interface — Sessions. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/recipe/session
      name: recipe-session
      description: REST surface for recipe-session.
      operations:
      - method: POST
        name: createsession
        description: Create Session
        call: core-driver-interface-sessions.createsession
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getsession
        description: Get Session
        call: core-driver-interface-sessions.getsession
        with:
          accessToken: rest.accessToken
          doAntiCsrfCheck: rest.doAntiCsrfCheck
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/recipe/session/data
      name: recipe-session-data
      description: REST surface for recipe-session-data.
      operations:
      - method: GET
        name: getsessiondata
        description: Get Session Data
        call: core-driver-interface-sessions.getsessiondata
        with:
          sessionHandle: rest.sessionHandle
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatesessiondata
        description: Update Session Data
        call: core-driver-interface-sessions.updatesessiondata
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/recipe/session/refresh
      name: recipe-session-refresh
      description: REST surface for recipe-session-refresh.
      operations:
      - method: POST
        name: refreshsession
        description: Refresh Session
        call: core-driver-interface-sessions.refreshsession
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/recipe/session/remove
      name: recipe-session-remove
      description: REST surface for recipe-session-remove.
      operations:
      - method: POST
        name: removesessions
        description: Remove Sessions
        call: core-driver-interface-sessions.removesessions
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: core-driver-interface-sessions-mcp
    port: 9090
    transport: http
    description: MCP adapter for SuperTokens Core Driver Interface — Sessions. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: create-session
      description: Create Session
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: core-driver-interface-sessions.createsession
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-session
      description: Get Session
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-driver-interface-sessions.getsession
      with:
        accessToken: tools.accessToken
        doAntiCsrfCheck: tools.doAntiCsrfCheck
      outputParameters:
      - type: object
        mapping: $.
    - name: get-session-data
      description: Get Session Data
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-driver-interface-sessions.getsessiondata
      with:
        sessionHandle: tools.sessionHandle
      outputParameters:
      - type: object
        mapping: $.
    - name: update-session-data
      description: Update Session Data
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: core-driver-interface-sessions.updatesessiondata
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: refresh-session
      description: Refresh Session
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: core-driver-interface-sessions.refreshsession
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-sessions
      description: Remove Sessions
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: core-driver-interface-sessions.removesessions
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.