The Open API specification for Synapse is now available for download!

Download Open API Spec



The enumeration of the possible alias types that can be bound to a principal. Note, these names must match those in AliasEnum. For an OAuthProvider type the matching alias is prefixed with USER_

name description
USER_NAME Alias used for the unique username of a user
TEAM_NAME Alias used for the unique name of a team
USER_EMAIL Alias used for the email address of a user
USER_OPEN_ID Deprecated
USER_ORCID Alias used for the ORCID identity of a user