Versions Compared

Key

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

...

API endpoints

Login user to AAS

POST

GET

/user/login?folderIds=Sjszo4cBdHmpxQQKUvah&folderIds=rjwQKYgBdHmpxQQKKgSs

Remarks

  • Basic Authentification requiredAuth required
  • This call delivers the JWT token (valid for 24h)

Status codes

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


...

Get info about logged-in user

GET

/user/info

Remarks

  • Login with user required

Status codes

Request body

Request-Body => Bookmark
{
       "id": "rjzgAIgBdHmpxQQKvQHm",                      // Not used
       "itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK",      // Required
       "description": "My important description",         // Optional
       "userId": "fachstelle_museum",                     // Not used
       "type": "CULTURAL_ITEM",                           // Required
       "createdAt": 1683641908448,                        // Not used
       "updatedAt": 1683641908448,                        // Not used
       "keywordTool": {                                   // Optional
             "done": true
       }
}

Response body

...

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


...

Get all user privileges

GET

/user/privileges

Remarks

  • Login with user permission required

Status codes

  • 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


...

Get all organizations of user

GET

/user/organizations

Remarks

  • Login with user permission required

Status codes

  • 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


...

Create new user

POST

/user

Remarks

  • No Login (anonymous) required

Status codes

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


...

Delete existing user

DELETE

/user/{id}

Remarks

  • Admin permission required

Status codes

  • 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

...