hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-18 15:33:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Polish the documentation

Browse Source
This commit is contained in:
krassowski
2024-04-10 14:52:23 +01:00
parent b486fc8abe
commit b79cb12095
1 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/source/reference/authenticators.md
View File

@@ -313,7 +313,7 @@ and roles cannot be specified with `load_groups` traitlet.
::: :::
Some identity providers may have their own concept of role membership that you would like to preserve in JupyterHub. Some identity providers may have their own concept of role membership that you would like to preserve in JupyterHub.
This is now possible with `Authenticator.manage_roles`. This is now possible with {attr}`.Authenticator.manage_roles`.
You can set the config: You can set the config:
@@ -335,13 +335,18 @@ which is a list of roles that user should be assigned to:
- Attributes of the roles (`description`, `scopes`, `groups`, `users`, and `services`) will be updated if given - Attributes of the roles (`description`, `scopes`, `groups`, `users`, and `services`) will be updated if given
- If `None` is returned, no changes are made to the user's roles - If `None` is returned, no changes are made to the user's roles
If authenticator-managed groups are enabled, If authenticator-managed roles are enabled,
all group-management via the API is disabled, all role-management via the API is disabled,
and roles cannot be assigned to groups nor users via `load_roles` traitlet and roles cannot be assigned to groups nor users via `load_roles` traitlet
(roles can still be created via `load_roles` or assigned to services). (roles can still be created via `load_roles` or assigned to services).
When an authenticator manages roles, the initial roles and role assignments When an authenticator manages roles, the initial roles and role assignments
can be loaded from role specifications returned by the `Authenticator.load_managed_roles()` method. can be loaded from role specifications returned by the {meth}`.Authenticator.load_managed_roles()` method.
The authenticator-manged roles and role assignment will be deleted after restart if:
- {attr}`.Authenticator.reset_managed_roles_on_startup` is set to `True` (default), and
- the roles and role assignments are not included in the initial set of roles returned by the {meth}`.Authenticator.load_managed_roles()` method.
## pre_spawn_start and post_spawn_stop hooks ## pre_spawn_start and post_spawn_stop hooks