Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 200 = Successful
  • 400 = Bad Request
  • 401 = User not authorized to login
  • 404 = User not found
  • 500 = Internal server error

Example call(s)

  • GET https://dev-ddb.fiz-karlsruhe.de/api/2/user/login


...

Get info about logged-in user

GET

/user/info

Remarks

  • Login with user required

...

  • 200 = Successful
  • 400 = Bad Request
  • 401 = User not authorized to login
  • 404 = User not found
  • 500 = Internal server error

Example call(s)

  • GET https://dev-ddb.fiz-karlsruhe.de/api/2/user/info


...

Get all user privileges

GET

/user/privileges

Remarks

  • Login with user permission required

...

  • 200 = Successful
  • 400 = Bad Request
  • 401 = User not authorized to login
  • 403 = Authentication temporarily blocked
  • 404 = User not found
  • 423 = User is blacklisted
  • 428 = User has "unconfirmed" status
  • 500 = Internal server error

Example call(s)

  • GET https://dev-ddb.fiz-karlsruhe.de/api/2/user/privileges


...

Get all organizations of user

GET

/user/organizations

Remarks

  • Login with user permission required

...

  • 200 = Successful
  • 304 = Attribute modified
  • 400 = Bad Request
  • 401 = User not authorized to login
  • 403 = Authentication temporarily blocked
  • 404 = User not found
  • 423 = User is blacklisted
  • 428 = User has "unconfirmed" status
  • 500 = Internal server error

Example call(s)

  • GET https://dev-ddb.fiz-karlsruhe.de/api/2/user/organizations


...

Create new user

POST

/user

Remarks

  • No Login (anonymous) required

...

  • 200 = Successful
  • 400 = Bad Request
  • 401 = User not authorized to login
  • 409 = Illegal State
  • 500 = Internal server error

Example call(s)

  • POST https://dev-ddb.fiz-karlsruhe.de/api/2/user


...

Delete existing user

DELETE

/user/{id}

Remarks

  • Admin permission required

...