Paragon Users API — Credentials

naftiko: 1.0.0-alpha2
info:
  label: Paragon Users API — Credentials
  description: 'Paragon Users API — Credentials. 2 operations. Lead operation: Paragon Get user credentials. Self-contained
    Naftiko capability covering one Paragon business surface.'
  tags:
  - Paragon
  - Credentials
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PARAGON_API_KEY: PARAGON_API_KEY
capability:
  consumes:
  - type: http
    namespace: users-credentials
    baseUri: https://api.useparagon.com
    description: Paragon Users API — Credentials business capability. Self-contained, no shared references.
    resources:
    - name: projects-projectId-sdk-credentials
      path: /projects/{projectId}/sdk/credentials
      operations:
      - name: getcredentials
        method: GET
        description: Paragon Get user credentials
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: Your Paragon Project ID.
          required: true
    - name: projects-projectId-sdk-credentials-credentialId
      path: /projects/{projectId}/sdk/credentials/{credentialId}
      operations:
      - name: updatecredential
        method: PATCH
        description: Paragon Update a credential
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: Your Paragon Project ID.
          required: true
        - name: credentialId
          in: path
          type: string
          description: The ID of the Connect credential to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.PARAGON_API_KEY}}'
  exposes:
  - type: rest
    namespace: users-credentials-rest
    port: 8080
    description: REST adapter for Paragon Users API — Credentials. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/projects/{projectid}/sdk/credentials
      name: projects-projectid-sdk-credentials
      description: REST surface for projects-projectId-sdk-credentials.
      operations:
      - method: GET
        name: getcredentials
        description: Paragon Get user credentials
        call: users-credentials.getcredentials
        with:
          projectId: rest.projectId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectid}/sdk/credentials/{credentialid}
      name: projects-projectid-sdk-credentials-credentialid
      description: REST surface for projects-projectId-sdk-credentials-credentialId.
      operations:
      - method: PATCH
        name: updatecredential
        description: Paragon Update a credential
        call: users-credentials.updatecredential
        with:
          projectId: rest.projectId
          credentialId: rest.credentialId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: users-credentials-mcp
    port: 9090
    transport: http
    description: MCP adapter for Paragon Users API — Credentials. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: paragon-get-user-credentials
      description: Paragon Get user credentials
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-credentials.getcredentials
      with:
        projectId: tools.projectId
      outputParameters:
      - type: object
        mapping: $.
    - name: paragon-update-credential
      description: Paragon Update a credential
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: users-credentials.updatecredential
      with:
        projectId: tools.projectId
        credentialId: tools.credentialId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.