PortainerCE API — auth

naftiko: 1.0.0-alpha2
info:
  label: PortainerCE API — auth
  description: 'PortainerCE API — auth. 3 operations. Lead operation: Authenticate. Self-contained Naftiko capability covering
    one Portainer business surface.'
  tags:
  - Portainer
  - auth
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PORTAINER_API_KEY: PORTAINER_API_KEY
capability:
  consumes:
  - type: http
    namespace: portainer-auth
    baseUri: ''
    description: PortainerCE API — auth business capability. Self-contained, no shared references.
    resources:
    - name: auth
      path: /auth
      operations:
      - name: authenticateuser
        method: POST
        description: Authenticate
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
          description: Credentials used for authentication
          required: true
    - name: auth-logout
      path: /auth/logout
      operations:
      - name: logout
        method: POST
        description: Logout
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: auth-oauth-validate
      path: /auth/oauth/validate
      operations:
      - name: validateoauth
        method: POST
        description: Authenticate with OAuth
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
          description: OAuth Credentials used for authentication
          required: true
  exposes:
  - type: rest
    namespace: portainer-auth-rest
    port: 8080
    description: REST adapter for PortainerCE API — auth. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/auth
      name: auth
      description: REST surface for auth.
      operations:
      - method: POST
        name: authenticateuser
        description: Authenticate
        call: portainer-auth.authenticateuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/auth/logout
      name: auth-logout
      description: REST surface for auth-logout.
      operations:
      - method: POST
        name: logout
        description: Logout
        call: portainer-auth.logout
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/auth/oauth/validate
      name: auth-oauth-validate
      description: REST surface for auth-oauth-validate.
      operations:
      - method: POST
        name: validateoauth
        description: Authenticate with OAuth
        call: portainer-auth.validateoauth
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: portainer-auth-mcp
    port: 9090
    transport: http
    description: MCP adapter for PortainerCE API — auth. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: authenticate
      description: Authenticate
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portainer-auth.authenticateuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: logout
      description: Logout
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portainer-auth.logout
      outputParameters:
      - type: object
        mapping: $.
    - name: authenticate-oauth
      description: Authenticate with OAuth
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portainer-auth.validateoauth
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.