/kb-search

description: Search the HaloPSA knowledge base for articles and solutions
argument-hint: "<query> [category] [visibility] [limit]"
arguments: [query, category, visibility, limit]

Search HaloPSA Knowledge Base

Search the HaloPSA knowledge base for articles and solutions to quickly find relevant information.

Prerequisites

• Valid HaloPSA OAuth credentials configured
• User must have knowledge base read permissions
• Knowledge base module enabled in HaloPSA

Steps

1. **Authenticate with OAuth 2.0**

• Obtain access token using client credentials flow
• Token endpoint: `{base_url}/auth/token?tenant={tenant}`

   # Get OAuth token
   TOKEN=$(curl -s -X POST "{base_url}/auth/token?tenant={tenant}" \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -d "grant_type=client_credentials" \
     -d "client_id={client_id}" \
     -d "client_secret={client_secret}" \
     -d "scope=all" | jq -r '.access_token')

2. **Get available categories (for validation)**

   curl -s -X GET "{base_url}/api/KBCategory" \
     -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json"

3. **Execute knowledge base search**

   curl -s -X GET "{base_url}/api/KBArticle?search={query}&page_size={limit}" \
     -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json"

4. **Apply filters**

• Filter by category if specified
• Filter by visibility (internal/public)

5. **Format and display results**

• Article list with summaries
• Link to full articles
• Related articles suggestions

Parameters

| Parameter | Type | Required | Default | Description | |-----------|------|----------|---------|-------------| | query | string | Yes | - | Search terms | | category | string | No | - | KB category filter | | visibility | string | No | all | internal/public/all | | limit | integer | No | 10 | Maximum results (max 50) |

Examples

Basic Search

/kb-search "password reset"

Category Filtered

/kb-search "VPN setup" --category "Network"

Internal Articles Only

/kb-search "troubleshooting" --visibility internal

Public Articles (Customer Facing)

/kb-search "how to" --visibility public

More Results

/kb-search "printer" --limit 20

Combined Filters

/kb-search "email configuration" --category "Email" --visibility internal --limit 15

Output

Search Results

Found 5 knowledge base articles matching "password reset"

================================================================================
KB SEARCH RESULTS
================================================================================

1. How to Reset Active Directory Passwords
   ────────────────────────────────────────────────────────────────────────────
   Category:    Active Directory
   Visibility:  Internal
   Views:       342
   Rating:      ★★★★★ (4.8/5)
   Updated:     2024-02-01

   Summary:
   Step-by-step guide for resetting user passwords in Active Directory,
   including self-service password reset (SSPR) and admin-initiated resets.

   Symptoms: User locked out, password expired, forgotten password

   View Article: /kb-article 1234

2. Self-Service Password Reset Portal Guide
   ────────────────────────────────────────────────────────────────────────────
   Category:    End User Guides
   Visibility:  Public
   Views:       1,245
   Rating:      ★★★★☆ (4.2/5)
   Updated:     2024-01-15

   Summary:
   End-user guide for using the self-service password reset portal.
   Includes registration and reset procedures.

   View Article: /kb-article 1235

3. Microsoft 365 Password Reset Procedures
   ────────────────────────────────────────────────────────────────────────────
   Category:    Microsoft 365
   Visibility:  Internal
   Views:       189
   Rating:      ★★★★★ (5.0/5)
   Updated:     2024-02-10

   Summary:
   Procedures for resetting passwords for Microsoft 365/Azure AD users,
   including MFA considerations and conditional access impacts.

   View Article: /kb-article 1236

4. Password Policy and Requirements
   ────────────────────────────────────────────────────────────────────────────
   Category:    Security
   Visibility:  Public
   Views:       567
   Rating:      ★★★★☆ (4.0/5)
   Updated:     2023-12-01

   Summary:
   Documentation of password complexity requirements, expiration policies,
   and password history settings.

   View Article: /kb-article 1237

5. Troubleshooting Password Sync Issues
   ────────────────────────────────────────────────────────────────────────────
   Category:    Active Directory
   Visibility:  Internal
   Views:       78
   Rating:      ★★★☆☆ (3.5/5)
   Updated:     2023-11-15

   Summary:
   Troubleshooting guide for Azure AD Connect password hash synchronization
   and pass-through authentication issues.

   View Article: /kb-article 1238

================================================================================

Quick Actions:
- View article:     /kb-article <id>
- Search more:      /kb-search "different terms"
- Browse category:  /kb-search --category "Active Directory"

Detailed Article View

================================================================================
KB Article: How to Reset Active Directory Passwords
================================================================================

Article ID:       1234
Category:         Active Directory
Visibility:       Internal (Staff Only)
Created:          2023-06-15
Last Updated:     2024-02-01
Author:           Jane Tech
Views:            342
Rating:           ★★★★★ (4.8/5 from 24 ratings)

SYMPTOMS
--------------------------------------------------------------------------------
- User reports "password expired" message
- User locked out of account
- User forgot password
- Password not syncing to cloud services

RESOLUTION
--------------------------------------------------------------------------------