/sso/login
postLogin
post
https://api-org.synap.ac/sso/login
When passed a valid user's email you will receive an authenticated URL.
Request
Response
Request
Headers
x-api-key
required
string
Your API usage token.
x-syn-org-id
required
string
Your organisation's identifier on Synap.
x-syn-org-secret
required
string
Your organisation"s secret key, used to authorise each request
content-type
required
string
application/json
Response
200: OK
Authentication successful.
{ "authenticatedURL": "https://example.synap.ac?st=< SESSION TOKEN >" }
401: Unauthorized
An invalid user email is passed to the API
{ "message": "you do not have permission to perform this operation" }
403: Forbidden
Your organisation secret key or api usage key is incorrect or has not been provided
{ "message": "you do not have permission to perform this operation" }
User
Attribute | Type | Required | Description |
string | yes | The user's email address |
cURL Request
Request Body
Response
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
{"user": {"email": "[email protected]"}}
Response
200 OK{"authenticatedURL": "https://yourPortalURL.ac?st=r:123sessiontoken567""timestamp": "2020-03-30T10:05:16.754Z"}--403 Forbidden{"code": 403,"error": "Unauthorised request."}--401 Unauthorized{"code": 401,"error": "Object not found."}
Last updated 1 year ago