MAKS-IT/maksit-certs-ui
1
0
Fork 0
mirror of https://github.com/MAKS-IT-COM/maksit-certs-ui.git synced 2026-06-10 00:28:11 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity
4543cfd02b
maksit-certs-ui/assets/docs/POWERSHELL_CLIENT_MODULE.md

2.8 KiB
Raw Blame History

PowerShell client module (MaksIT.CertsUI.Client.PowerShell)

PowerShell module that exposes the MaksIT CertsUI API via custom cmdlets, built on MaksIT.CertsUI.Client (C# / .NET).

Source: src/MaksIT.CertsUI.Client.PowerShell/ · Auth & routes: USER_AND_API_KEY_RBAC.md · Permission matrices: RBAC_REFERENCE.md · E2E: src/e2e-tests/README.md · Repo entry: README.md

Requirements

  • Latest PowerShell 7 with a .NET 10 host. pwsh 7.4 on .NET 8 cannot load this net10.0 module.
[System.Runtime.InteropServices.RuntimeInformation]::FrameworkDescription
# expect: .NET 10.0.x

Installation

  1. Build the solution (or the MaksIT.CertsUI.Client.PowerShell project).

  2. Import from build output:

    Import-Module .\src\MaksIT.CertsUI.Client.PowerShell\bin\Debug\net10.0\MaksIT.CertsUI.Client.PowerShell.psd1 -Force

Usage

  1. Connect (base URL is the public ingress or YARP root, e.g. http://localhost:8080 — no /api suffix):

    Connect-CertsUI -BaseAddress "http://localhost:8080" -ApiKey "your-api-key"

  2. Health and accounts:

    Test-CertsUIHealth
Get-CertsUIAccounts
Get-CertsUIAccount -AccountId <guid>

  3. HA / load-balancer check:

    Get-CertsUIRuntimeInstanceId

  4. Create / patch / delete account (create runs the full ACME flow — use staging for tests):

    Invoke-CertsUICreateAccount -Description "e2e" -Contacts "mailto:a@b" -ChallengeType "http-01" -Hostnames "example.com" -IsStaging -AgreeToS
Invoke-CertsUIPatchAccount -AccountId <guid> -Description "updated"
Invoke-CertsUIDeleteAccount -AccountId <guid>

  5. Disconnect:

    Disconnect-CertsUI

Cmdlets

Cmdlet Description
Connect-CertsUI Set base URL and API key for the session
Disconnect-CertsUI Clear session
Test-CertsUIHealth GET /health/live and /health/ready (ready returns 503 until migrations and bootstrap finish)
Get-CertsUIAccounts GET /api/accounts
Get-CertsUIAccount GET /api/account/{id}
Get-CertsUIRuntimeInstanceId GET /api/debug/runtime-instance-id
Invoke-CertsUICreateAccount POST /api/account
Invoke-CertsUIPatchAccount PATCH /api/account/{id}
Invoke-CertsUIDeleteAccount DELETE /api/account/{id}

E2E scenarios

PowerShell scenarios under src/e2e-tests/ build this module and run registered tests. See src/e2e-tests/README.md.