add section for username_claim (#26876)

This commit is contained in:
Yassine Bounekhla 2023-05-26 12:38:27 +01:00 committed by GitHub
parent b3e7a30f8b
commit c2e4871725
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -239,6 +239,22 @@ spec:
allow_unverified_email: true
```
### Optional: Specify a claim to use as the username
By default, Teleport will use the user's email as their Teleport username.
You can define a `username_claim` to specify the claim that should be used as the username instead.
```yaml
kind: oidc
version: v2
metadata:
name: connector
spec:
# Use the `preferred_username` claim as the user's Teleport username.
username_claim: preferred_username
```
## Testing
For the Web UI, if the above configuration were real, you would see a button