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

Download Open API Spec

POST /oauth2/authurl

The first step in OAuth authentication involves sending the user to authenticate on an OAuthProvider's web page. Use this method to get a properly formed URL to redirect the browser to an OAuthProvider's authentication page. Upon successful authentication at the OAuthProvider's page, the provider will redirect the browser to the redirectURL. The provider will add a query parameter to the redirect URL named "code". The code parameter's value is an authorization code that must be provided to Synapse to validate a user. Note: The 'state' field in the request body is an arbitrary string that certain Oauth providers (including Google) will return as a request parameter in the redirect URL. (The handling of 'state' is not prescribed by the OAuth standard.)

Resource URL

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

Resource Information
Authentication not required
HTTP Method POST
Request Object OAuthUrlRequest
(application/json)
Response Object OAuthUrlResponse
(application/json)