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


^ Back to top

...

US02 | Get info about logged-in user

...

  • 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


^ Back to top

...

US03 | Get all user privileges

...

  • 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

...

  • 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

...

{
    "nickname": "testuser-ri",
    "email": "testuser-ri@ddb.de",
    "pswd": "testuser-ri"
}

Response payload

Code Block
languagejs
linenumberstrue
collapsetrue
{
    "id": "cb5d9c5810e985e7beda092b22e1e480",
    "nickname": "testuser-ri",
    "status": "CONFIRMED",
    "surName": "surname is unknown",
    "email": "testuser-ri-1@ddb.de",
    "created": "2024-01-31T12:13:30",
    "creatorId": "anonymous",
    "modified": "2024-01-31T12:13:30",
    "modifierId": "anonymous"
}


Returns User JSON object:

...

  • 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

...

  • 204 = User successful deleted
  • 400 = Bad Request
  • 401 = User not authorized to login
  • 404 = User not found
  • 423 = User is blacklisted
  • 428 = User has "unconfirmed" status
  • 500 = Internal server error

Example call(s)

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

...