Security

Security related operations

Login

POST http://biostudy-prod.ebi.ac.uk:8788/auth/login

Retrieves the user authentication token. Example: curl -X POST \ -d '{ "login": "[e-mail]", "password": "123456" }' \ http://biostudy-prod.ebi.ac.uk:8788/auth/login

Request Body

Name	Type	Description
login	string	User login or email
password	string	User password

200

{
    "sessid": "<user-token>",
    "email": "[e-mail]",
    "username": "admin_user",
    "secret": "<user secret>",
    "fullname": "Admin User",
    "superuser": true,
    "allow": [
        "[e-mail]",
        "Public"
    ],
    "deny": [],
    "aux": {
        "orcid": "<the orcid>"
    }
}

401

{
    "status": "FAIL",
    "log": {
        "level": "ERROR",
        "message": "Invalid email address or password.",
        "subnodes": []
    }
}

Logout

POST http://biostudy-prod.ebi.ac.uk:8788/auth/logout

Expires the given authorization token. Example: curl -X POST \ -d '{ "sessid": "<user token>" }' \ http://biostudy-prod.ebi.ac.uk:8788/auth/logout

Request Body

Name	Type	Description
sessid	string	Authorization token to expire

200

User Info

GET http://biostudy-prod.ebi.ac.uk:8788/auth/profile

Get the information of a user. Example: curl -H "X-SESSION-TOKEN: <authToken>" \ http://biostudy-prod.ebi.ac.uk:8788/auth/profile

Headers

Name	Type	Description
X-SESSION-TOKEN	string	User authentication token

200

{
    "sessid": "<user-token>",
    "email": "[e-mail]",
    "username": "admin_user",
    "secret": "<user secret>",
    "fullname": "Admin User",
    "superuser": true,
    "allow": [
        "[e-mail]",
        "Public"
    ],
    "deny": [],
    "aux": {
        "orcid": "<the orcid>"
    }
}

500 Caused by an invalid user token

Change Password

POST http://biostudy-prod.ebi.ac.uk:8788/auth/password/change

Change the user password. Example: curl -X POST -d '{ "activationKey": "the-activation-key", "password": "123456" }' \ http://biostudy-prod.ebi.ac.uk:8788/auth/password/change

Request Body

Name	Type	Description
activationKey	string	User activation key
password	string	New password

200

Password Reset

POST http://biostudy-prod.ebi.ac.uk:8788/auth/password/reset

Reset the user password. An E-Mail is sent to the user in order to create the new password. Example: curl -X POST \ -d '{ "email": "[e-mail]", "instanceKey": "the-instance-key", "path": "/the/path" }' \ http://biostudy-prod.ebi.ac.uk:8788/auth/password/reset

Request Body

Name	Type	Description
email	string	User email
instanceKey	string	Instance key that asks for the password reset
path	string	User path
recaptcha2-response	string	Recaptcha response

200