Skip to content
This repository has been archived by the owner on Oct 15, 2019. It is now read-only.

API User

DennisSentler edited this page Oct 10, 2019 · 3 revisions

API Documentation

This article documentates the User/Auth API.

This API is designed for use in Clouddrop context.

Services:

  1. Register
  2. Login
  3. Logout
  4. Authenticate a token
  5. Get a single user
  6. Update user data
  7. Delete a user

Register

REQUEST

POST /user

HEADER
Headername Value
Content-Type application/json
BODY
{
 "name": "Some Name",
 "email": "some@mail.com",
 "password": "********"
}

RESPONSE

HEADER
Headername Value
Statuscode 204

Login

REQUEST

GET /user/login

HEADER
Headername Value
Authorization Basic <encodedBase64(Email:Password)>

RESPONSE

HEADER
Headername Value
Statuscode 204
Authorization Bearer <JSON Web Token>

Logout

REQUEST

GET /user/logout

HEADER
Headername Value
Authorization Bearer <JSON Web Token>

RESPONSE

HEADER
Headername Value
Statuscode 204

Authenticate a token

REQUEST

GET /user/auth

HEADER
Headername Value
Authorization Bearer <JSON Web Token>

RESPONSE

HEADER
Headername Value
Statuscode 200
Content-Type application/json
BODY
{
 "jws": "<JSON Web Token>",
 "email": "some@email.com",
 "role": "user"
}

Get user

REQUEST

GET /user/{email}

HEADER
Headername Value
Authorization Bearer <JSON Web Token>

RESPONSE

HEADER
Headername Value
Statuscode 200
Content-Type application/json
BODY
{
 "name": "Some Name",
 "email": "some@mail.com",
 "password": "********",
 "role": "user"
}

Update user

REQUEST

PUT /user/{email}

HEADER
Headername Value
Authorization Bearer <JSON Web Token>
Content-Type application/json
BODY
{
 "name": "New Name",
}

RESPONSE

HEADER
Headername Value
Statuscode 204

Delete user

REQUEST

DELETE user/{email}

HEADER
Headername Value
Authorization Bearer <JSON Web Token>

RESPONSE

HEADER
Headername Value
Statuscode 204