diff --git a/doc/POABackend.Auth.REST.html b/doc/POABackend.Auth.REST.html index 803e8f1..2b45bd7 100644 --- a/doc/POABackend.Auth.REST.html +++ b/doc/POABackend.Auth.REST.html @@ -170,9 +170,9 @@ content-length: 362 cache-control: max-age=0, private, must-revalidate {"token":"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJwb2FfYmFja2VuZCIsImV4cCI6MTUzMzkzNjMwNiwiaWF0IjoxNTMzOTMyNzA2LCJpc3MiOiJwb2FfYmFja2VuZCIsImp0aSI6ImI0MzBkNTMwLWExZDYtNDk1Yy1hMjYyLThjNTcxMmM1OTM4YSIsIm5iZiI6MTUzMzkzMjcwNSwic3ViIjoiUmp1YURzdi0iLCJ0eXAiOiJhY2Nlc3MifQ.E3gqpCxY5wAAhZwcr7vZVLcC7X-bSHcXfX6NgeJc-LMbpcDgJvZgcgYQ-VTIkulb2mWw_Fjc7sXVwYMeIIliMg"} -

- - User Endpoint +

+ + Create User Endpoint

This Endpoint is needed in order to add a new user. Only Admin people can do that.

@@ -352,6 +352,83 @@ server: Cowboy date: Tue, 04 Sep 2018 13:49:45 GMT content-length: 0 cache-control: max-age=0, private, must-revalidate +

+ + Update User Endpoint +

+ +

This Endpoint is needed in order to update a user. Currently only the active property can be updated. If a user is set to active: false means +it was banned. We can use this enpoint in order to ban or unban users too.

+

PATCH /user/:username

+ ++++ + + + + + + + + + + + +
HTTP headerValues
content-typeapplication/json or application/msgpack
authorizationBasic encodeBase64(adminname + “:” + password)
+ ++++ + + + + + + + + + + + +
PayloadValue
JSON{“active” : boolean()}
MessagePackSame as JSON but packed with MessagePack
+

Response

+ ++++ + + + + + + + + + + + + + + + + + + + + +
CODEDescription
204Success
401Authentication failed
404The user doesn’t exist
415Unsupported Media Type (only application/json and application/msgpack allowed)
422Unprocessable entity (the active value is not a boolean)
+

Example:

+
curl -i -X PATCH -H "Authorization: Basic YWRtaW4xOnBhc3N3b3JkMTIzNDU2Nzg=" -H "Content-Type: application/json" -d '{"active":false}' https://localhost:4003/user/cZFxFfNT --insecure
+
+HTTP/1.1 204 No Content
+server: Cowboy
+date: Wed, 05 Sep 2018 13:38:32 GMT
+content-length: 0
+cache-control: max-age=0, private, must-revalidate

Blacklist Token Endpoint