Page History

Login to the REST API using a DSpace EPerson (user). It returns a token JSESSIONID cookie, that can be used for future authenticated requests (as a value of the rest-dspace-token request header).

Example Request:

curl -

v "https://dspace.myu.edu/rest/login?email=admin@dspace.org&password=dspace"

Example Response:

HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=6B98CF8648BCE57DCD99689FE77CB1B8; Path=/rest/; Secure; HttpOnly

Example of using JSESSIONID cookie for subsequent (authenticated) requests:

curl -v "https://dspace.myu.edu/rest/status" --cookie "JSESSIONID=6B98CF8648BCE57DCD99689FE77CB1B8"
# This should return <authenticated>true</authenticated>, and information about the authenticated user session

Example Response:

1febef81-5eb6-4e76-a0ea-a5be245563a5

Invalid email/password combinations will receive an HTTP 403 Forbidden.401 Unauthorized response.

Please note, special characters may need to be HTTP URL encoded. For example, an email address like dspacedemo+admin@gmail.com (notice the + special character) would need to be encoded as dspacedemo%2Badmin@gmail.com.

Logout from the REST API, by providing a JSESSIONID cookie

Logout from the REST API, by providing a header rest-dspace-token. After being posted this token cookie will no longer work.

Example Request:

curl -X POST -

v "https://dspace.myu.edu/rest/logout" --cookie "JSESSIONID=6B98CF8648BCE57DCD99689FE77CB1B8"

After posting a logout request, cookie is invalidated and the "/status" path should show you as unauthenticated (even when passing that same cookie). For example:

curl -v "https://dspace.myu.edu/rest/status" --cookie "JSESSIONID=6B98CF8648BCE57DCD99689FE77CB1B8"
# This should show <authenticated>false</authenticated>

Invalid token will result in HTTP 400 Invalid Request

Returns string "REST api is running", for testing that the API is up.

Example Request:

curl

Example Response:

REST api is running.

 https://dspace.myu.edu/rest/test

Example Response:

REST api is running.

Receive information about the currently authenticated user token.

Example Request (XML by default):

curl -v "https://dspace.myu.edu/rest/status" --cookie "JSESSIONID=6B98CF8648BCE57DCD99689FE77CB1B8"

Example Request (JSON):

curl -X GET -H 

Receive information about the currently authenticated user token.

Example Request:

"Content-Type: application/json" -H

 "Accept: application/json" -v "https://dspace.myu.edu/rest/status" --cookie "JSESSIONID=6B98CF8648BCE57DCD99689FE77CB1B8"

Example JSON Response:

{"okay":true,"authenticated":true,"email":"

dspacedemo+admin@gmail.

com","fullname":"DSpace

 Administrator"}