Skip to content

Commit 7cc225c

Browse files
committed
updated api doc with user endpoints update serviceInfo
1 parent e264df2 commit 7cc225c

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

REST_API_InternalDoc.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ not all services need to be in every message only those you would like to change
316316
### returns
317317
the metadata of each user
318318
```json{
319-
"SystemUsers":[
319+
"systemUsers":[
320320
{"Name": "Dan", "Group": "Yellow", "Token": "Token1", "Password": "psw1", , "Certs": "a.zip"},
321321
{"Name": "Joe", "Group": "Yellow", "Token": "Token1", "Password": "psw1", , "Certs": "a.zip"},
322322
{"Name": "Bill", "Group": "Yellow", "Token": "Token1", "Password": "psw1", , "Certs": "a.zip"}
@@ -327,6 +327,8 @@ not all services need to be in every message only those you would like to change
327327
None
328328

329329
## addSystemUsers
330+
used to create a new system user on the server<br />
331+
Event: `addSystemUsers` <br />
330332
### returns
331333
None
332334
### parameters
@@ -344,8 +346,19 @@ None
344346
* Password: password for user(optional)
345347
* Certs: whether the user should have certs generated(should be true in ui)
346348
## removeSystemUsers
347-
not yet implemented
348-
349+
used to remove a system user and their associated files from the server<br />
350+
Event: `removeSystemUsers` <br />
351+
###returns
352+
None
353+
### parameters
354+
```json
355+
{ "systemUsers":
356+
[
357+
{ "uid": "46b3de87-85f5-400d-a098-536f2e1421ce" }
358+
]
359+
}
360+
```
361+
* uid: uid of user to remove
349362
## DataPackageTable
350363
### description
351364
Endpoint used to access data regarding DataPackages

0 commit comments

Comments
 (0)