diff options
| author | Joas Schilling <coding@schilljs.com> | 2019-10-10 10:28:49 +0300 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2019-10-10 12:19:22 +0300 |
| commit | 3b90447cd9599faebdf1c90eefa96ff429cb021f (patch) | |
| tree | 5ec41f04f47e2268b232472f865da040c1261c70 /docs | |
| parent | f368fd97129c7ddae8db911823aa4a167d998352 (diff) | |
Add docs for password request
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/integration.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/integration.md b/docs/integration.md index d96603be8..dab8c0671 100644 --- a/docs/integration.md +++ b/docs/integration.md @@ -48,3 +48,27 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` field | type | Description ------|------|------------ `token` | string | The token of the conversation for this file + +## Create a conversation to request the password for a public share + +* Method: `POST` +* Endpoint: `/publicshareauth` +* Data: + + field | type | Description + ------|------|------------ + `shareToken` | string | Share token for which the conversation should be given + +* Response: + - Header: + + `200 OK` + + `404 Not Found` When the share was not found + + `404 Not Found` When "Request password via Talk" is not active for the share + + - Data: + + field | type | Description + ------|------|------------ + `token` | string | The token of the conversation for this file + `name` | string | A technical name for the conversation + `displayName` | string | The visual name of the conversation |