...
API endpoints
US01 | Login user
GET | /user/login |
|---|
Basic Authentification required
...
...
US02 | Get user info
GET | /user/info |
|---|
User permission required
...
US03 | Get user privileges
GET | /user/privileges |
|---|
User permission required
...
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/user/privileges
...
US04 | Get user organizations
GET | /user/organizations |
|---|
User permission required
...
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/user/organizations
...
US05 | Create user
POST | /user |
|---|
No Login (anonymous) required
...
- POST https://dev-ddb.fiz-karlsruhe.de/api/2/user
...
US06 | Delete user
DELETE | /user/{id} |
|---|
Admin permission required
...
- DELETE https://dev-ddb.fiz-karlsruhe.de/api/2/user/cb5d9c5810e985e7beda092b22e1e480
...
US07 | Confirm user action
PUT | /user/{id}/confirm/{token} |
|---|
...
- PUT https://dev-ddb.fiz-karlsruhe.de/api/2/user/2443f6d538fd09d00b5f8add909fc2a5/confirm/8f01fda7-5660-4687-8cf9-797276c4bc59
...
US08 | Get user by email
GET | /user/email/{email} |
|---|
Admin permission required
...
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/user/email/testuser@ddb.de
...
US09 | Change user password
PUT | /user/{id}/password |
|---|
User permission required
...
- PUT https://dev-ddb.fiz-karlsruhe.de/api/2/user/2443f6d538fd09d00b5f8add909fc2a5/password
...
US10 | Reset user password
PUT | /user/{id}/passwordreset |
|---|
No Login (anonymous) required
...
- PUT https://dev-ddb.fiz-karlsruhe.de/api/2/user/59ab798971240c9c3556e627864430a9/resetpassword
...
US11 | Update user email
PUT | /user/{id}/email |
|---|
User permission required
...
- PUT https://dev-ddb.fiz-karlsruhe.de/api/2/user/59ab798971240c9c3556e627864430a9/email
...
US12 | Update user metadata
PUT | /user/{id} |
|---|
User permission required
...
- PUT https://dev-ddb.fiz-karlsruhe.de/api/2/user/793feaf72b465c17be1e2d86c7a0a057
...
US13 | Get user by id
GET | /user/{id} |
|---|
Admin permission required
...
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/user/2443f6d538fd09d00b5f8add909fc2a5
...
US14 | Get global privilege
GET | /user/privileges/{privilege} |
|---|
...
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/user/privileges/FACHSTELLE_ARCHIV
...
US15 | Search for users
GET | /user/search |
|---|
Admin permission required
...
| 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
} |
...
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/user/search?status=CONFIRMED&salutation=Herr&sort=surName/sort.ascending&start=1&count=2