Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Correct documentation for map_user_attributes of OpenID Mapping Providers #13836

Merged
merged 4 commits into from
Sep 21, 2022
Merged

Correct documentation for map_user_attributes of OpenID Mapping Providers #13836

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a71feb3
Update sso_mapping_providers.md
peterscheu-aceart Sep 19, 2022
e7d337c
add changelog
peterscheu-aceart Sep 19, 2022
87e48b0
Also describe new attributes while I'm here
Sep 21, 2022
48fa7ef
Reword confirm_localpart
Sep 21, 2022
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
1 change: 1 addition & 0 deletions changelog.d/13836.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix a mistake in sso_mapping_providers.md: `map_user_attributes` is expected to return `display_name` not `displayname`.
2 changes: 1 addition & 1 deletion docs/sso_mapping_providers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ A custom mapping provider must specify the following methods:
`None`, the user is prompted to pick their own username. This is only used
during a user's first login. Once a localpart has been associated with a
remote user ID (see `get_remote_user_id`) it cannot be updated.
- `displayname`: An optional string, the display name for the user.
- `display_name`: An optional string, the display name for the user.
* `async def get_extra_attributes(self, userinfo, token)`
- This method must be async.
- Arguments:
Expand Down