Skip to content

[v18] Docs: Document OIDC Setting Enabling Signed Request Objects #59911

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
rhammonds-teleport merged 4 commits into from
Oct 9, 2025
Merged

[v18] Docs: Document OIDC Setting Enabling Signed Request Objects #59911

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3825e24
Update OIDC SSO docs to describe new 'request_object_mode' which enab…
rhammonds-teleport Jul 31, 2025
62dfbf3
Describe how to retrieve oidc_idp public key via tctl.
rhammonds-teleport Aug 4, 2025
ea623a1
* Add a few words explaining that request objects can also be configu…
rhammonds-teleport Sep 23, 2025
d8037cb
Document release versions where request object support is introduced.
rhammonds-teleport Sep 23, 2025
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
52 changes: 52 additions & 0 deletions docs/pages/zero-trust-access/sso/oidc.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,58 @@ spec:
username_claim: preferred_username
```

### Optional: Request object mode

Teleport supports the ability to send authorization request parameters in a
JSON Web Token (JWT), referred to as "request objects", following RFC 9101.
Presently, Teleport only supports signed request objects sent by value. This
option necessitates that the IdP be provided with, or configured to discover,
Teleport's JSON Web Key Sets (JWKS) used for OIDC IdP integration in order to
verify request object signatures. This JWKS can be found at the `/.well-known/jwks-oidc`
path of the Web API.

Additionally, the public key to be used for verifying request object signatures can
be found via `tctl`.

```code
$ tctl get cert_authority/oidc_idp/$CLUSTER_NAME --format=json | jq -r .[].spec.active_keys.jwt[].public_key
```

By default, `request_object_mode` is unset, meaning authorization request parameters
will be sent in the query string of the authorization endpoint.

```yaml
kind: oidc
version: v2
metadata:
name: connector
spec:
# Use signed request objects when making authorization requests to the IdP.
request_object_mode: signed
```

Request objects are also supported for MFA checks. If `request_object_mode` is not
explicitly set on the MFA client, the login client's request object mode will be used
by default. If desired, you can explicitly configure the MFA client to use a separate
request object mode.

```yaml
kind: oidc
version: v2
metadata:
name: connector
spec:
client_id: teleport_login
client_secret: abc123...
request_object_mode: none
mfa:
client_id: teleport_mfa
client_secret: mfa123...
request_object_mode: signed
```

Note: Support for request objects is available in Teleport Enterprise versions `17.7.2` or later and `18.1.6` or later.

## Enable default OIDC authentication

(!docs/pages/includes/enterprise/oidcauthentication.mdx!)
Expand Down
Loading