Skip to content

Standardize User-Agent and add telemetry headers #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
luke-hagar-sp wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Standardize User-Agent and add telemetry headers #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72fdc6e
Standardize User-Agent and add telemetry headers
luke-hagar-sp Mar 4, 2026
6856737
Consolidate telemetry into User-Agent header, remove custom X-SailPoi…
luke-hagar-sp Mar 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions sailpoint/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ def __init__(self, configurationParams: ConfigurationParams = None) -> None:
self.experimental = False
self.suppress_experimental_warnings = False

# Optional consumer identifier for User-Agent suffix (e.g. "sailpoint-cli")
self.consumer_identifier = None
# Optional consumer version for User-Agent suffix (e.g. "1.2.3")
self.consumer_version = None

self.temp_folder_path = None
"""Temp file folder for downloading files
"""
Expand Down
7 changes: 6 additions & 1 deletion sdk-resources/resources/api_client.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ import decimal
import json
import mimetypes
import os
import platform
import re
import sys
import tempfile
import xmltodict

Expand Down Expand Up @@ -95,7 +97,10 @@ class ApiClient:
self.default_headers[header_name] = header_value
self.cookie = cookie
# Set default User-Agent.
self.user_agent = '{{{httpUserAgent}}}{{^httpUserAgent}}OpenAPI-Generator/{{{packageVersion}}}/python{{/httpUserAgent}}'
self.user_agent = 'SailPoint-SDK-Python/{{{packageVersion}}}'
if configuration and getattr(configuration, 'consumer_identifier', None) and getattr(configuration, 'consumer_version', None):
self.user_agent = f'{self.user_agent} ({configuration.consumer_identifier}/{configuration.consumer_version})'
self.user_agent = f'{self.user_agent} ({sys.platform}; {platform.machine()}) Python/{sys.version.split()[0]} (openapi-generator/{{generatorVersion}})'
self.client_side_validation = configuration.client_side_validation

{{#asyncio}}
Expand Down