Skip to content

Standardize User-Agent and add telemetry headers#155

Merged
luke-hagar-sp merged 2 commits intomainfrom
feature/standardize-useragent-headers
Mar 18, 2026
Merged

Standardize User-Agent and add telemetry headers#155
luke-hagar-sp merged 2 commits intomainfrom
feature/standardize-useragent-headers

Conversation

@luke-hagar-sp
Copy link
Contributor

Summary

  • Replace OpenAPI-Generator/1.7.16/ps User-Agent with SailPoint-SDK/powershell/1.7.16 to differentiate our published SDK from customer-generated clients
  • Add ConsumerIdentifier and ConsumerVersion configuration fields so consumers can identify themselves: SailPoint-SDK/powershell/1.7.16 (sailpoint-cli/1.2.3)
  • Standardize X-SailPoint-SDK header to powershell/{ver} format (was Powershell-{ver})
  • Add X-SailPoint-SDK-Runtime (e.g. powershell/7.4.1) and X-SailPoint-SDK-OS telemetry headers

Files changed

  • PSSailpoint/Configuration.ps1 — new consumer fields in Get-DefaultConfiguration and Set-DefaultConfiguration
  • sdk-resources/resources/api_client.mustache — dynamic User-Agent with consumer suffix, updated X-SailPoint-SDK, added telemetry headers

Test plan

  • Run make build to regenerate all versioned packages
  • Verify PSSailpoint/v3/src/PSSailpoint.V3/Private/ApiClient.ps1 contains new header format
  • Run Invoke-Pester -Output Detailed ./PSSailpoint/tests/ to verify no regressions
  • Verify Set-DefaultConfiguration -ConsumerIdentifier "my-app" -ConsumerVersion "1.0" works
  • Verify consumer fields are optional (no suffix when unset)

🤖 Generated with Claude Code

Replace generic OpenAPI-Generator User-Agent with SailPoint-SDK/powershell/{ver}
format. Add ConsumerIdentifier/ConsumerVersion fields to Configuration
for consumers to identify themselves in the User-Agent via parenthetical
suffix. Standardize X-SailPoint-SDK to powershell/{ver} format and add
X-SailPoint-SDK-Runtime and X-SailPoint-SDK-OS telemetry headers.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…nt-* headers

Format: SailPoint-SDK-PowerShell/{version} ({os}; {arch}) PowerShell/{ps-version} (openapi-generator/{gen-version})

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@luke-hagar-sp luke-hagar-sp merged commit a37c3a9 into main Mar 18, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants