Skip to content

docs(security): document OAuth access tokens on the APIToken scheme #111

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
steve-calvert-glean merged 3 commits into from
Jun 15, 2026
+31 −0
Merged

docs(security): document OAuth access tokens on the APIToken scheme #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa7430c
Add OAuth Client API security scheme overlay
steve-calvert-glean Jun 15, 2026
aed8f77
Format OAUTH_SDK_DESIGN.md with prettier
steve-calvert-glean Jun 15, 2026
1d65272
refactor(oauth): reduce overlay to APIToken description clarification
steve-calvert-glean Jun 15, 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
2 changes: 2 additions & 0 deletions .speakeasy/workflow.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ sources:
- location: overlays/custom-metadata-modifications-overlay.yaml
- location: overlays/agent-modifications-overlay.yaml
- location: overlays/admin-modifications-overlay.yaml
- location: overlays/oauth-client-security-overlay.yaml
output: overlayed_specs/glean-merged-spec.yaml
registry:
location: registry.speakeasyapi.dev/glean-el2/sdk/glean-api-specs
Expand All @@ -29,6 +30,7 @@ sources:
- location: overlays/client-modifications-overlay.yaml
- location: overlays/agent-modifications-overlay.yaml
- location: overlays/admin-modifications-overlay.yaml
- location: overlays/oauth-client-security-overlay.yaml
output: overlayed_specs/glean-client-api-specs.yaml
glean-client-merged-code-samples-spec:
inputs:
Expand Down
29 changes: 29 additions & 0 deletions overlays/oauth-client-security-overlay.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
overlay: 1.0.0
x-speakeasy-jsonpath: rfc9535
info:
title: OAuth Client API security
version: 0.0.1
# A Glean API token and an OAuth access token are both HTTP bearer credentials,
# so the existing single APIToken security scheme already covers both — no
# separate OAuth security scheme is required, and the generated SDKs keep their
# existing flat `apiToken` constructor field. This overlay only clarifies the
# scheme description to document OAuth usage.
#
# External-IdP OAuth tokens additionally require the `X-Glean-Auth-Type: OAUTH`
# request header, which the caller supplies (e.g. a per-request header option on
# the SDKs, or a custom HTTP client). Glean-issued OAuth tokens (Glean OAuth
# Authorization Server, including Dynamic Client Registration clients) are
# detected by issuer and need no header.
#
# OAuth applies to the Client API only; the Indexing API accepts Glean-issued
# tokens exclusively.
actions:
- target: $.components.securitySchemes.APIToken
update:
description: >-
HTTP bearer token. Accepts a Glean-issued API token, an OAuth access
token from the Glean OAuth Authorization Server (including Dynamic Client
Registration clients), or an OAuth access token issued by an external
identity provider. External-IdP OAuth tokens must also include the
`X-Glean-Auth-Type: OAUTH` request header. OAuth is supported on the
Client API only; the Indexing API requires a Glean-issued token.
Loading