Skip to content

docs: add auth scopes breaking change to A365 migration guide #123

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

Merged
hectorhdzg merged 2 commits into from
May 6, 2026
+30 −0
Merged

docs: add auth scopes breaking change to A365 migration guide #123

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
21242f0
docs: add auth scopes breaking change to A365 migration guide
hectorhdzg May 6, 2026
f599f3b
docs: fix auth scope to match PROD_OBSERVABILITY_SCOPE, fix helper re…
hectorhdzg May 6, 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
30 changes: 30 additions & 0 deletions MIGRATION_A365.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,36 @@ the filter logic to any criteria (span name, attributes, etc.).
| `ENABLE_OTLP_EXPORTER` | `OTEL_EXPORTER_OTLP_ENDPOINT` | Use standard OTel env var instead |
| `ENABLE_OBSERVABILITY` | `ENABLE_OBSERVABILITY` | Same — master switch for A365 scope classes to emit spans |

## Auth Scopes — Breaking Change

> **⚠️ Breaking change:** The default observability authentication scope changed
> from `https://api.powerplatform.com/.default` (old A365 SDK) to
> `api://9b975845-388f-4429-889e-eab1ef63949c/Agent365.Observability.OtelWrite`.
> If you previously hardcoded the old scope, you will get auth failures after
> migration. You must also grant the `Agent365.Observability.OtelWrite`
> permission — see [HTTP 403 after upgrading](#http-403-after-upgrading).

Do **not** hardcode scope strings. Instead, use the runtime helper to get the
correct scope automatically:

```python
from microsoft.opentelemetry.a365.runtime import get_observability_authentication_scope

scopes = get_observability_authentication_scope() # returns list[str]
```

If you need to override the scope for testing, use the
`a365_observability_scope_override` kwarg or the
`A365_OBSERVABILITY_SCOPE_OVERRIDE` environment variable:

```bash
# Linux / macOS
export A365_OBSERVABILITY_SCOPE_OVERRIDE="api://test/.default"

# Windows PowerShell
$env:A365_OBSERVABILITY_SCOPE_OVERRIDE = "api://test/.default"
```

## Full Migration Example

```python
Expand Down
Loading