/sso/login

Login

POST https://api-org.synap.ac/sso/login

When passed a valid user's email you will receive an authenticated URL.

Headers

Name	Type	Description
x-api-key	string	Your API usage token.
x-syn-org-id	string	Your organisation's identifier on Synap.
x-syn-org-secret	string	Your organisation"s secret key, used to authorise each request
content-type	string	application/json

200 Authentication successful.

{ "authenticatedURL": "https://example.synap.ac?st=< SESSION TOKEN >" }

401 An invalid user email is passed to the API

403 Your organisation secret key or api usage key is incorrect or has not been provided

Body Parameters

User

Attribute	Type	Required	Description
email	string	yes	The user's email address

Examples

cURL Request

curl --request POST \
  --url https://api-org.synap.ac/sso/login \
  --header 'content-type: application/json' \
  --header 'x-syn-org-id: org123test' \
  --header 'x-syn-org-secret: secret123test' \
  --header 'x-api-key: test123api' \
  --data '{
	"user": {
		"email": "[email protected]"
	}
}'

Request Body

Response