mirror of
https://github.com/gravitational/teleport.git
synced 2026-10-12 02:15:01 +00:00
Document jwt_claims app rewrite option (#30256)
* Document `jwt_claims` app rewrite option * resolve comments * Update JWT section and untabify
This commit is contained in:
@@ -280,6 +280,31 @@ Additionally, the `{{internal.jwt}}` template variable will be replaced with
|
||||
a JWT token signed by Teleport that contains user identity information. See
|
||||
[Integrating with JWTs](../jwt/introduction.mdx) for more details.
|
||||
|
||||
### Configuring the JWT token
|
||||
|
||||
By default, Teleport includes a user's roles and traits in the JWT
|
||||
generated for application access. If your application doesn't care
|
||||
about these values, or you are encountering an error due to exceeding
|
||||
the size limit of HTTP headers, you can configure Teleport to omit
|
||||
this information from the token.
|
||||
|
||||
```yaml
|
||||
- name: "dashboard"
|
||||
uri: https://localhost:4321
|
||||
public_addr: dashboard.example.com
|
||||
rewrite:
|
||||
# Specify whether to include roles or traits in the JWT.
|
||||
# Options:
|
||||
# - roles-and-traits: include both roles and traits
|
||||
# - roles: include only roles
|
||||
# - none :exclude both roles and traits from the JWT token
|
||||
# Default: roles-and-traits
|
||||
jwt_claims: roles-and-traits
|
||||
headers:
|
||||
# Inject header with Teleport-signed JWT token.
|
||||
- "Authorization: Bearer {{internal.jwt}}"
|
||||
```
|
||||
|
||||
## View applications in Teleport
|
||||
|
||||
Teleport provides a UI for quickly launching connected applications.
|
||||
|
||||
@@ -49,4 +49,11 @@ app_service:
|
||||
# headers:
|
||||
# For example:
|
||||
# - "Host: jenkins.example.com"
|
||||
## Optional rewrite to remove parts of the JWT token.
|
||||
## Can be one of three options:
|
||||
## - roles-and-traits: include both roles and traits in the JWT token
|
||||
## - roles: include only roles in the JWT token
|
||||
## - none: include neither roles nor traits in the JWT token
|
||||
## Default: roles-and-traits
|
||||
# jwt_claims: roles-and-traits
|
||||
|
||||
|
||||
Reference in New Issue
Block a user