Correct documentation for map_user_attributes of OpenID Mapping Providers

[peterscheu-aceart]

Changed displayname to display_name.
See /synapse/handlers/sso.py L130.

[DMRobertson]

See /synapse/handlers/sso.py L130.

I think the change is correct, but to see this we also need to check

synapse/synapse/handlers/oidc.py

Lines 949 to 973 in fe1daad

	async def oidc_response_to_user_attributes(failures: int) -> UserAttributes:
	"""
	Call the mapping provider to map the OIDC userinfo and token to user attributes.
	This is backwards compatibility for abstraction for the SSO handler.
	"""
	if supports_failures:
	attributes = await self._user_mapping_provider.map_user_attributes(
	userinfo, token, failures
	)
	else:
	# If the mapping provider does not support processing failures,
	# do not continually generate the same Matrix ID since it will
	# continue to already be in use. Note that the error raised is
	# arbitrary and will get turned into a MappingException.
	if failures:
	raise MappingException(
	"Mapping provider does not support de-duplicating Matrix IDs"
	)
	attributes = await self._user_mapping_provider.map_user_attributes(
	userinfo, token
	)
	return UserAttributes(**attributes)

which shows how a UserAttributes is constructed when a user mapping provider is involved.

[DMRobertson]

I think this is correct, but I am always nervous around sso. @clokep can you double-check this please?

[clokep]

I think this is correct, but I am always nervous around sso. @clokep can you double-check this please?

This change seems correct, yes. We directly convert the results of that dictionary into UserAttributes, as you found!

That documentation seems to also be missing the confirm_localpart and emails parameters that got added.

[DMRobertson]

That documentation seems to also be missing the confirm_localpart and emails parameters that got added.

I've had a go at this while I'm here.