...
- 200 = Successful confirmation
- 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
...
US09 | Change user password
PUT | /user/{id}/password |
|---|
User permission required
Request payload
...
US10 | Reset user password
PUT | /user/{id}/passwordreset |
|---|
No Login (anonymous) required
...
...
US11 | Update user email
PUT | /user/{id}/email |
|---|
User permission required
Request payload
...
US12 | Update user metadata
PUT | /user/{id} |
|---|
User permission required
Request payload
...
...
US13 | Get user by id
GET | /user/{id} |
|---|
Admin permission required
...
US14 | Get global privilege
GET | /user/privileges/{privilege} |
|---|
Admin permission required
...
...
US15 | Search for users
GET | /user/search |
|---|
Admin permission required
Query parameters
| Name | Value | Occurence | Default | Required | Example |
|---|---|---|---|---|---|
| count | Number of hits to return | Once | 20 | Optional | count=10 |
| start | Start of first hit | Once | 1 | Optional | start=4 |
| sort | Field and sorting criteria
| Once | - | Optional | sort=surName/sort.ascending sort=foreName/sort.descending |
| <fieldname> | Value to search
| Multiple | - | Optional | status=CONFIRMED salutation=Herr |
Response payload
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"results": {
"person": [
{
"id": "fb37beba5bfba23405b42dcf6a0db219",
"nickname": "ddbCronjobAdmin",
"status": "CONFIRMED",
"salutation": "Herr",
"foreName": "ddbCronjob",
"surName": "Admin",
"email": "ddbcronjobadmin@fiz-karlsruhe.de",
"telephoneNumber": "123456",
"created": "2021-11-12T03:11:10",
"creatorId": "anonymous",
"modified": "2021-11-12T08:17:06",
"modifierId": "admin"
},
{
"id": "5f1571def309f4e30f16f8b85cd64534",
"nickname": "m.buechner@dnb.de",
"status": "CONFIRMED",
"salutation": "Herr",
"foreName": "Michael",
"surName": "Büchner",
"email": "m.buechner@dnb.de",
"telephoneNumber": "+49 69 1525-1774",
"created": "2020-12-17T17:37:24",
"creatorId": "anonymous",
"modified": "2020-12-17T17:38:58",
"modifierId": "e08d8db1bb28b584753129a055a9b548",
"apiKey": "zY9hPyNwGDWX4JjIeuHuNg6J8VFGj6h35TIDDSfuzdrIKiaKBIs1531832617312"
}
]
},
"start": 1,
"count": 2,
"totalHits": 39
} |
...