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

Download Open API Spec

POST /oauth2/alias

After a user has been authenticated at an OAuth provider's web page, the provider will redirect the browser to the provided redirectUrl. The provider will add a query parameter to the redirectUrl called "code" that represents the authorization code for the user. This method will use the authorization code to fetch the provider's ID for the user. The provider's ID will then be bound to the user's account as a new 'alias'. Note: Some alias types (like ORCID) allow just one value per account. For such aliases, an error will be returned if the user tries to bind more than one such alias.

Resource URL

https://repo-prod.prod.sagebase.org/auth/v1/oauth2/alias

Resource Information
Authentication Required
HTTP Method POST
Request Object OAuthValidationRequest
(application/json)
Response Object PrincipalAlias
(application/json)