GitHub User API — Get

naftiko: 1.0.0-alpha2
info:
  label: GitHub User API — Get
  description: 'GitHub User API — Get. 16 operations. Lead operation: GitHub Get Users Statistics. Self-contained Naftiko
    capability covering one Github business surface.'
  tags:
  - Github
  - Get
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GITHUB_API_KEY: GITHUB_API_KEY
capability:
  consumes:
  - type: http
    namespace: users-get
    baseUri: ''
    description: GitHub User API — Get business capability. Self-contained, no shared references.
    resources:
    - name: enterprise-stats-users
      path: /enterprise/stats/users
      operations:
      - name: getusersstatistics
        method: GET
        description: GitHub Get Users Statistics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: repos-owner-repo-branches-branch-protection-restrictions-users
      path: /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users
      operations:
      - name: getuserswithaccesstotheprotectedbranch
        method: GET
        description: GitHub Get Users with Access to the Protected Branch
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: user
      path: /user
      operations:
      - name: gettheauthenticateduser
        method: GET
        description: GitHub Get the Authenticated User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: user-docker-conflicts
      path: /user/docker/conflicts
      operations:
      - name: getlistofconflictingpackagesduringdockermigrationforauthenticateduser
        method: GET
        description: GitHub Get List of Conflicting Packages During Docker Migration for Authenticated-user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: user-gpg_keys-gpg_key_id
      path: /user/gpg_keys/{gpg_key_id}
      operations:
      - name: getgpgkeyfortheauthenticateduser
        method: GET
        description: GitHub Get Gpg Key for the Authenticated User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: user-keys-key_id
      path: /user/keys/{key_id}
      operations:
      - name: getpublicsshkeyfortheauthenticateduser
        method: GET
        description: GitHub Get Public Ssh Key for the Authenticated User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: user-memberships-orgs-org
      path: /user/memberships/orgs/{org}
      operations:
      - name: getanorganizationmembershipfortheauthenticateduser
        method: GET
        description: GitHub Get an Organization Membership for the Authenticated User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: user-packages-package_type-package_name
      path: /user/packages/{package_type}/{package_name}
      operations:
      - name: getpackagefortheauthenticateduser
        method: GET
        description: GitHub Get Package for the Authenticated User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: user-packages-package_type-package_name-versions-package_version_id
      path: /user/packages/{package_type}/{package_name}/versions/{package_version_id}
      operations:
      - name: getpackageversionfortheauthenticateduser
        method: GET
        description: GitHub Get Package Version for the Authenticated User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: user-ssh_signing_keys-ssh_signing_key_id
      path: /user/ssh_signing_keys/{ssh_signing_key_id}
      operations:
      - name: getansshsigningkeyfortheauthenticateduser
        method: GET
        description: GitHub Get an Ssh Signing Key for the Authenticated User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: users-username
      path: /users/{username}
      operations:
      - name: getuser
        method: GET
        description: GitHub Get User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: users-username-docker-conflicts
      path: /users/{username}/docker/conflicts
      operations:
      - name: getlistofconflictingpackagesduringdockermigrationforuser
        method: GET
        description: GitHub Get List of Conflicting Packages During Docker Migration for User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: users-username-hovercard
      path: /users/{username}/hovercard
      operations:
      - name: getcontextualinformationforuser
        method: GET
        description: GitHub Get Contextual Information for User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subject_type
          in: query
          type: string
          description: Identifies which additional information you'd like to receive about the person's hovercard. Can be
            `organization`, `repository`, `issue`, `pull_request`. **Requ
        - name: subject_id
          in: query
          type: string
          description: Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: users-username-installation
      path: /users/{username}/installation
      operations:
      - name: getuserinstallationfortheauthenticatedapp
        method: GET
        description: GitHub Get User Installation for the Authenticated App
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: users-username-packages-package_type-package_name
      path: /users/{username}/packages/{package_type}/{package_name}
      operations:
      - name: getpackageforuser
        method: GET
        description: GitHub Get Package for User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    - name: users-username-packages-package_type-package_name-versions-package_version_id
      path: /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}
      operations:
      - name: getpackageversionforuser
        method: GET
        description: GitHub Get Package Version for User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
        - name: X-GitHub-Api-Version
          in: header
          type: string
        - name: Accept
          in: header
          type: string
    authentication:
      type: bearer
      token: '{{env.GITHUB_API_KEY}}'
  exposes:
  - type: rest
    namespace: users-get-rest
    port: 8080
    description: REST adapter for GitHub User API — Get. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/enterprise/stats/users
      name: enterprise-stats-users
      description: REST surface for enterprise-stats-users.
      operations:
      - method: GET
        name: getusersstatistics
        description: GitHub Get Users Statistics
        call: users-get.getusersstatistics
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users
      name: repos-owner-repo-branches-branch-protection-restrictions-users
      description: REST surface for repos-owner-repo-branches-branch-protection-restrictions-users.
      operations:
      - method: GET
        name: getuserswithaccesstotheprotectedbranch
        description: GitHub Get Users with Access to the Protected Branch
        call: users-get.getuserswithaccesstotheprotectedbranch
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/user
      name: user
      description: REST surface for user.
      operations:
      - method: GET
        name: gettheauthenticateduser
        description: GitHub Get the Authenticated User
        call: users-get.gettheauthenticateduser
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/user/docker/conflicts
      name: user-docker-conflicts
      description: REST surface for user-docker-conflicts.
      operations:
      - method: GET
        name: getlistofconflictingpackagesduringdockermigrationforauthenticateduser
        description: GitHub Get List of Conflicting Packages During Docker Migration for Authenticated-user
        call: users-get.getlistofconflictingpackagesduringdockermigrationforauthenticateduser
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/user/gpg-keys/{gpg-key-id}
      name: user-gpg-keys-gpg-key-id
      description: REST surface for user-gpg_keys-gpg_key_id.
      operations:
      - method: GET
        name: getgpgkeyfortheauthenticateduser
        description: GitHub Get Gpg Key for the Authenticated User
        call: users-get.getgpgkeyfortheauthenticateduser
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/user/keys/{key-id}
      name: user-keys-key-id
      description: REST surface for user-keys-key_id.
      operations:
      - method: GET
        name: getpublicsshkeyfortheauthenticateduser
        description: GitHub Get Public Ssh Key for the Authenticated User
        call: users-get.getpublicsshkeyfortheauthenticateduser
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/user/memberships/orgs/{org}
      name: user-memberships-orgs-org
      description: REST surface for user-memberships-orgs-org.
      operations:
      - method: GET
        name: getanorganizationmembershipfortheauthenticateduser
        description: GitHub Get an Organization Membership for the Authenticated User
        call: users-get.getanorganizationmembershipfortheauthenticateduser
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/user/packages/{package-type}/{package-name}
      name: user-packages-package-type-package-name
      description: REST surface for user-packages-package_type-package_name.
      operations:
      - method: GET
        name: getpackagefortheauthenticateduser
        description: GitHub Get Package for the Authenticated User
        call: users-get.getpackagefortheauthenticateduser
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/user/packages/{package-type}/{package-name}/versions/{package-version-id}
      name: user-packages-package-type-package-name-versions-package-version-id
      description: REST surface for user-packages-package_type-package_name-versions-package_version_id.
      operations:
      - method: GET
        name: getpackageversionfortheauthenticateduser
        description: GitHub Get Package Version for the Authenticated User
        call: users-get.getpackageversionfortheauthenticateduser
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/user/ssh-signing-keys/{ssh-signing-key-id}
      name: user-ssh-signing-keys-ssh-signing-key-id
      description: REST surface for user-ssh_signing_keys-ssh_signing_key_id.
      operations:
      - method: GET
        name: getansshsigningkeyfortheauthenticateduser
        description: GitHub Get an Ssh Signing Key for the Authenticated User
        call: users-get.getansshsigningkeyfortheauthenticateduser
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{username}
      name: users-username
      description: REST surface for users-username.
      operations:
      - method: GET
        name: getuser
        description: GitHub Get User
        call: users-get.getuser
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{username}/docker/conflicts
      name: users-username-docker-conflicts
      description: REST surface for users-username-docker-conflicts.
      operations:
      - method: GET
        name: getlistofconflictingpackagesduringdockermigrationforuser
        description: GitHub Get List of Conflicting Packages During Docker Migration for User
        call: users-get.getlistofconflictingpackagesduringdockermigrationforuser
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{username}/hovercard
      name: users-username-hovercard
      description: REST surface for users-username-hovercard.
      operations:
      - method: GET
        name: getcontextualinformationforuser
        description: GitHub Get Contextual Information for User
        call: users-get.getcontextualinformationforuser
        with:
          subject_type: rest.subject_type
          subject_id: rest.subject_id
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{username}/installation
      name: users-username-installation
      description: REST surface for users-username-installation.
      operations:
      - method: GET
        name: getuserinstallationfortheauthenticatedapp
        description: GitHub Get User Installation for the Authenticated App
        call: users-get.getuserinstallationfortheauthenticatedapp
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{username}/packages/{package-type}/{package-name}
      name: users-username-packages-package-type-package-name
      description: REST surface for users-username-packages-package_type-package_name.
      operations:
      - method: GET
        name: getpackageforuser
        description: GitHub Get Package for User
        call: users-get.getpackageforuser
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{username}/packages/{package-type}/{package-name}/versions/{package-version-id}
      name: users-username-packages-package-type-package-name-versions-package-version-id
      description: REST surface for users-username-packages-package_type-package_name-versions-package_version_id.
      operations:
      - method: GET
        name: getpackageversionforuser
        description: GitHub Get Package Version for User
        call: users-get.getpackageversionforuser
        with:
          Authorization: rest.Authorization
          X-GitHub-Api-Version: rest.X-GitHub-Api-Version
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: users-get-mcp
    port: 9090
    transport: http
    description: MCP adapter for GitHub User API — Get. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: github-get-users-statistics
      description: GitHub Get Users Statistics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-get.getusersstatistics
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-users-access-protected
      description: GitHub Get Users with Access to the Protected Branch
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-get.getuserswithaccesstotheprotectedbranch
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-authenticated-user
      description: GitHub Get the Authenticated User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-get.gettheauthenticateduser
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-list-conflicting-packages
      description: GitHub Get List of Conflicting Packages During Docker Migration for Authenticated-user
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-get.getlistofconflictingpackagesduringdockermigrationforauthenticateduser
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-gpg-key-authenticated
      description: GitHub Get Gpg Key for the Authenticated User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-get.getgpgkeyfortheauthenticateduser
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-public-ssh-key
      description: GitHub Get Public Ssh Key for the Authenticated User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-get.getpublicsshkeyfortheauthenticateduser
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-organization-membership-authenticated
      description: GitHub Get an Organization Membership for the Authenticated User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-get.getanorganizationmembershipfortheauthenticateduser
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-package-authenticated-user
      description: GitHub Get Package for the Authenticated User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-get.getpackagefortheauthenticateduser
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-package-version-authenticated
      description: GitHub Get Package Version for the Authenticated User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-get.getpackageversionfortheauthenticateduser
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-ssh-signing-key
      description: GitHub Get an Ssh Signing Key for the Authenticated User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-get.getansshsigningkeyfortheauthenticateduser
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-user
      description: GitHub Get User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-get.getuser
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-list-conflicting-packages-2
      description: GitHub Get List of Conflicting Packages During Docker Migration for User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-get.getlistofconflictingpackagesduringdockermigrationforuser
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-contextual-information-user
      description: GitHub Get Contextual Information for User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-get.getcontextualinformationforuser
      with:
        subject_type: tools.subject_type
        subject_id: tools.subject_id
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-user-installation-authenticated
      description: GitHub Get User Installation for the Authenticated App
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-get.getuserinstallationfortheauthenticatedapp
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-package-user
      description: GitHub Get Package for User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-get.getpackageforuser
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-package-version-user
      description: GitHub Get Package Version for User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: users-get.getpackageversionforuser
      with:
        Authorization: tools.Authorization
        X-GitHub-Api-Version: tools.X-GitHub-Api-Version
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.