Skip to content

Commit

Permalink
docs: update azuread docs about auth_state_groups_key
Browse files Browse the repository at this point in the history
  • Loading branch information
consideRatio committed Sep 3, 2024
1 parent c16bb8c commit f92b511
Showing 1 changed file with 1 addition and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,14 @@ be relevant to read more about in the configuration reference:
## Loading user groups

The `AzureAdOAuthenticator` can load the group-membership of users from the access token.
This is done by setting the `AzureAdOAuthenticator.groups_claim` to the name of the claim that contains the
group-membership.

```python
c.JupyterHub.authenticator_class = "azuread"

# {...} other settings (see above)

c.AzureAdOAuthenticator.manage_groups = True
c.AzureAdOAuthenticator.user_groups_claim = 'groups' # this is the default
c.AzureAdOAuthenticator.auth_state_groups_key = 'user.groups'
```

This requires Azure AD to be configured to include the group-membership in the access token.

0 comments on commit f92b511

Please sign in to comment.