docs(Readme.md): Update Readme

This commit is contained in:
Valentin Kolb 2024-03-27 18:18:43 +01:00
parent d1c4813692
commit ad0c60cc4f
1 changed files with 81 additions and 0 deletions

View File

@ -216,6 +216,87 @@ Es wird überprüft, ob der User der das GET Request schickt in der `LDAP_ADMIN_
curl -X GET https://it.stuve.uni-ulm.de/api/ldap/search -d '{"baseDN": "ou=useraccounts,ou=user,dc=stuve,dc=uni-ulm,dc=de", "filter": "(cn=vorname.nachname)"}' curl -X GET https://it.stuve.uni-ulm.de/api/ldap/search -d '{"baseDN": "ou=useraccounts,ou=user,dc=stuve,dc=uni-ulm,dc=de", "filter": "(cn=vorname.nachname)"}'
``` ```
Als return wir ein JSON Objekt nach folgendem Schema zurückgegeben:
```json
{
"Entries": [
{
"DN": "CN=vorname.nachname,OU=UserAccounts,OU=User,DC=stuve,DC=uni-ulm,DC=de",
"Attributes": [
{
"Name": "cn",
"Values": [
"vorname.nachname"
],
"ByteValues": [
"xxxxxxxxxxxxxxx"
]
}
]
}
],
"Referrals": [],
"Controls": []
}
```
Json Schemata:
```json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"Entries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"DN": {
"type": "string"
},
"Attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Values": {
"type": "array",
"items": {
"type": "string"
}
},
"ByteValues": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["Name", "Values", "ByteValues"]
}
}
},
"required": ["DN", "Attributes"]
}
},
"Referrals": {
"type": "array",
"items": {}
},
"Controls": {
"type": "array",
"items": {}
}
},
"required": ["Entries", "Referrals", "Controls"]
}
```
### LDAP Sync ### LDAP Sync
Dieses Package ist das umfangreichste Package und synchronisiert Dieses Package ist das umfangreichste Package und synchronisiert