Versions Compared

Key

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

...

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


^ Back to top

...

US07 |

...

Confirm user action

PUT

/{id}/confirm/{token}

No Login (anonymous) required

Response payload

Code Block
languagejs
themeMidnight
titleUser object
linenumberstrue
collapsetrue
{
    "id": "2443f6d538fd09d00b5f8add909fc2a5",
    "nickname": "testuser",
    "status": "CONFIRMED",
    "surName": "surname is unknown",
    "email": "testuser-ri-2@ddb.de",
    "created": "2024-03-07T11:04:58",
    "creatorId": "anonymous",
    "modified": "2024-03-07T11:06:32",
    "modifierId": "anonymous"
}

Status codes

  • 204 = Successful confimation
  • 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

...

^ Back to top

...

US08 | Get user by email

GET

/email/{email}

Admin permission required

Response payload

Code Block
languagejs
themeMidnight
titleUser object
linenumberstrue
collapsetrue
{
    "id": "2443f6d538fd09d00b5f8add909fc2a5",
    "nickname": "testuser",
    "status": "CONFIRMED",
    "surName": "surname is unknown",
    "email": "testuser@ddb.de",
    "created": "2024-03-07T11:04:58",
    "creatorId": "anonymous",
    "modified": "2024-03-07T11:06:32",
    "modifierId": "anonymous"
}

Status codes

  • 204 = User successful retrieved
  • 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

...