NextGen Catalog API — Users

naftiko: 1.0.0-alpha2
info:
  label: NextGen Catalog API — Users
  description: 'NextGen Catalog API — Users. 3 operations. Lead operation: Update user information given a user''s email..
    Self-contained Naftiko capability covering one National Archives And Records Administration business surface.'
  tags:
  - National Archives And Records Administration
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NATIONAL_ARCHIVES_AND_RECORDS_ADMINISTRATION_API_KEY: NATIONAL_ARCHIVES_AND_RECORDS_ADMINISTRATION_API_KEY
capability:
  consumes:
  - type: http
    namespace: national-archives-and-records-administration-users
    baseUri: https://catalog.archives.gov/api/v2
    description: NextGen Catalog API — Users business capability. Self-contained, no shared references.
    resources:
    - name: users
      path: /users
      operations:
      - name: patch
        method: PATCH
        description: Update user information given a user's email.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: users-notifications-:userId
      path: /users/notifications/:userId
      operations:
      - name: get
        method: GET
        description: Recieve the users notifications.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: path
          type: string
          description: userId of the user recieving notifications.
          required: true
        - name: countOnly
          in: query
          type: boolean
          description: Recieve only the count of notifications, and none of the contributions.
        - name: date
          in: query
          type: string
          description: Recieve only the notifications past a certain date. Date must be in YYYY-MM-DD format.
        - name: limit
          in: query
          type: int
          description: Limit the amount of returned notifications.
        - name: page
          in: query
          type: int
          description: Page number for pagination of notifications. Page size is denoted by limit, defaults to 5. For example,
            if page = 3 notifications 10-14 will be returned.
    - name: users-username
      path: /users/username
      operations:
      - name: patch
        method: PATCH
        description: Update a users username given their userId.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: national-archives-and-records-administration-users-rest
    port: 8080
    description: REST adapter for NextGen Catalog API — Users. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/users
      name: users
      description: REST surface for users.
      operations:
      - method: PATCH
        name: patch
        description: Update user information given a user's email.
        call: national-archives-and-records-administration-users.patch
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/notifications/userid
      name: users-notifications-userid
      description: REST surface for users-notifications-:userId.
      operations:
      - method: GET
        name: get
        description: Recieve the users notifications.
        call: national-archives-and-records-administration-users.get
        with:
          userId: rest.userId
          countOnly: rest.countOnly
          date: rest.date
          limit: rest.limit
          page: rest.page
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/username
      name: users-username
      description: REST surface for users-username.
      operations:
      - method: PATCH
        name: patch
        description: Update a users username given their userId.
        call: national-archives-and-records-administration-users.patch
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: national-archives-and-records-administration-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for NextGen Catalog API — Users. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: update-user-information-given-user-s
      description: Update user information given a user's email.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: national-archives-and-records-administration-users.patch
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: recieve-users-notifications
      description: Recieve the users notifications.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: national-archives-and-records-administration-users.get
      with:
        userId: tools.userId
        countOnly: tools.countOnly
        date: tools.date
        limit: tools.limit
        page: tools.page
      outputParameters:
      - type: object
        mapping: $.
    - name: update-users-username-given-their
      description: Update a users username given their userId.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: national-archives-and-records-administration-users.patch
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.