diff --git a/README.md b/README.md index b5e8dde..02c4570 100644 --- a/README.md +++ b/README.md @@ -162,7 +162,7 @@ Notfications are used to inform a receiver about something. Unlike requests, not | method_name | string | name of the method to invoke | | params | array | method specific parameters | -### Requests +### Requests (Adapter -> Provider) #### lookup @@ -300,6 +300,26 @@ Read from an open file. | "identiy" | Use data as is; note that JSON strings are UTF-8 encoded | | "base64" | data is base64 encoded | +### Requests (Provider -> Adapter) + +#### authtenticate + +Authenticate the provider. +If authentication is enabled, a provider must be authenticated by the adapter before the adapter will send any messages. + + fs provider: {"method": "authenticate", "params": [, ], "id": } + webfuse daemon: {"result": {}, "id": } + +| Item | Data type | Description | +| ----------- | ----------| ------------------------------- | +| type | string | authentication type (see below) | +| credentials | object | credentials to authenticate | + +##### authentication types + +- **username**: authenticate via username and password + `{"username": , "password": }` + ## Build and run To install dependencies, see below.