Cisco NX-API REST — Authentication

naftiko: 1.0.0-alpha2
info:
  label: Cisco NX-API REST — Authentication
  description: 'Cisco NX-API REST — Authentication. 2 operations. Lead operation: Authenticate and Obtain Session Cookie.
    Self-contained Naftiko capability covering one Cisco Nexus business surface.'
  tags:
  - Cisco Nexus
  - Authentication
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CISCO_NEXUS_API_KEY: CISCO_NEXUS_API_KEY
capability:
  consumes:
  - type: http
    namespace: nxapi-rest-authentication
    baseUri: https://{switchIp}/api
    description: Cisco NX-API REST — Authentication business capability. Self-contained, no shared references.
    resources:
    - name: aaaLogin.json
      path: /aaaLogin.json
      operations:
      - name: authenticateuser
        method: POST
        description: Authenticate and Obtain Session Cookie
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: aaaLogout.json
      path: /aaaLogout.json
      operations:
      - name: logoutuser
        method: POST
        description: Terminate Authenticated Session
        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: APIC-cookie
      value: '{{env.CISCO_NEXUS_API_KEY}}'
      placement: cookie
  exposes:
  - type: rest
    namespace: nxapi-rest-authentication-rest
    port: 8080
    description: REST adapter for Cisco NX-API REST — Authentication. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/aaalogin-json
      name: aaalogin-json
      description: REST surface for aaaLogin.json.
      operations:
      - method: POST
        name: authenticateuser
        description: Authenticate and Obtain Session Cookie
        call: nxapi-rest-authentication.authenticateuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/aaalogout-json
      name: aaalogout-json
      description: REST surface for aaaLogout.json.
      operations:
      - method: POST
        name: logoutuser
        description: Terminate Authenticated Session
        call: nxapi-rest-authentication.logoutuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: nxapi-rest-authentication-mcp
    port: 9090
    transport: http
    description: MCP adapter for Cisco NX-API REST — Authentication. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: authenticate-and-obtain-session-cookie
      description: Authenticate and Obtain Session Cookie
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: nxapi-rest-authentication.authenticateuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: terminate-authenticated-session
      description: Terminate Authenticated Session
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: nxapi-rest-authentication.logoutuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.