2018-07-05 10:50:56 +00:00
|
|
|
|
# [WIP] Nextcloud Go API Client
|
|
|
|
|
|
|
|
|
|
A simple Client for Nextcloud's API in Go.
|
|
|
|
|
|
|
|
|
|
## TODO
|
|
|
|
|
- [Auth](#authentication)
|
|
|
|
|
- ~~login~~
|
|
|
|
|
- ~~logout~~
|
|
|
|
|
- [Users](#users)
|
|
|
|
|
- ~~search~~
|
|
|
|
|
- ~~list~~
|
|
|
|
|
- ~~get infos~~
|
|
|
|
|
- ~~create~~
|
2018-07-05 13:01:25 +00:00
|
|
|
|
- ~~update~~
|
2018-07-05 10:50:56 +00:00
|
|
|
|
- ~~delete~~
|
2018-07-05 13:01:25 +00:00
|
|
|
|
- ~~enable~~
|
|
|
|
|
- ~~disable~~
|
2018-07-05 14:15:51 +00:00
|
|
|
|
- ~~get groups~~
|
|
|
|
|
- ~~add to group~~
|
|
|
|
|
- ~~remove from group~~
|
|
|
|
|
- ~~get subadmin group~~
|
|
|
|
|
- ~~promote subadmin~~
|
|
|
|
|
- ~~demote subadmin~~
|
2018-07-05 13:01:25 +00:00
|
|
|
|
- ~~send welcome mail~~
|
2018-07-05 10:50:56 +00:00
|
|
|
|
- [Groups](#groups)
|
|
|
|
|
- create
|
|
|
|
|
- delete
|
|
|
|
|
- get members
|
|
|
|
|
- get subadmins
|
|
|
|
|
- [Apps](#apps)
|
|
|
|
|
- list
|
|
|
|
|
- get infos
|
|
|
|
|
- enable
|
|
|
|
|
- disable
|
|
|
|
|
|
|
|
|
|
# Getting started
|
|
|
|
|
## Authentication
|
|
|
|
|
```go
|
|
|
|
|
package main
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"fmt"
|
|
|
|
|
"github.com/partitio/gonextcloud/client"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
func main() {
|
|
|
|
|
url := "https://www.mynextcloud.com"
|
|
|
|
|
username := "admin"
|
|
|
|
|
password := "password"
|
|
|
|
|
c, err := client.NewClient(url)
|
|
|
|
|
if err != nil {
|
|
|
|
|
panic(err)
|
|
|
|
|
}
|
|
|
|
|
if err := c.Login(username, password); err != nil {
|
|
|
|
|
panic(err)
|
|
|
|
|
}
|
|
|
|
|
defer c.Logout()
|
|
|
|
|
}
|
|
|
|
|
````
|
2018-07-05 10:52:31 +00:00
|
|
|
|
## Users
|
2018-07-05 10:50:56 +00:00
|
|
|
|
List :
|
|
|
|
|
```go
|
|
|
|
|
func (c *Client) UserList() ([]string, error)
|
|
|
|
|
```
|
|
|
|
|
Search
|
|
|
|
|
```go
|
|
|
|
|
func (c *Client) UserSearch(search string) ([]string, error)
|
|
|
|
|
```
|
|
|
|
|
Get
|
|
|
|
|
```go
|
|
|
|
|
func (c *Client) User(name string) (*types.User, error)
|
|
|
|
|
```
|
|
|
|
|
Create
|
|
|
|
|
```go
|
|
|
|
|
func (c *Client) UserCreate(username string, password string) error
|
|
|
|
|
```
|
|
|
|
|
Delete
|
|
|
|
|
```go
|
|
|
|
|
func (c *Client) UserDelete(name string) error
|
|
|
|
|
```
|
2018-07-05 13:01:25 +00:00
|
|
|
|
Enable
|
|
|
|
|
```go
|
|
|
|
|
func (c *Client) UserEnable(name string) error
|
|
|
|
|
```
|
|
|
|
|
Disable
|
|
|
|
|
```go
|
|
|
|
|
func (c *Client) UserDisable(name string) error
|
|
|
|
|
```
|
|
|
|
|
Update
|
|
|
|
|
```go
|
|
|
|
|
func (c *Client) UserUpdateEmail(name string, email string) error
|
2018-07-05 14:19:55 +00:00
|
|
|
|
```
|
|
|
|
|
```go
|
2018-07-05 13:01:25 +00:00
|
|
|
|
func (c *Client) UserUpdateDisplayName(name string, displayName string) error
|
2018-07-05 14:19:55 +00:00
|
|
|
|
```
|
|
|
|
|
```go
|
2018-07-05 13:01:25 +00:00
|
|
|
|
func (c *Client) UserUpdatePhone(name string, phone string) error
|
2018-07-05 14:19:55 +00:00
|
|
|
|
```
|
|
|
|
|
```go
|
2018-07-05 13:01:25 +00:00
|
|
|
|
func (c *Client) UserUpdateAddress(name string, address string) error
|
2018-07-05 14:19:55 +00:00
|
|
|
|
```
|
|
|
|
|
```go
|
2018-07-05 13:01:25 +00:00
|
|
|
|
func (c *Client) UserUpdateWebSite(name string, website string) error
|
2018-07-05 14:19:55 +00:00
|
|
|
|
```
|
|
|
|
|
```go
|
2018-07-05 13:01:25 +00:00
|
|
|
|
func (c *Client) UserUpdateTwitter(name string, twitter string) error
|
2018-07-05 14:19:55 +00:00
|
|
|
|
```
|
|
|
|
|
```go
|
2018-07-05 13:01:25 +00:00
|
|
|
|
func (c *Client) UserUpdatePassword(name string, password string) error
|
2018-07-05 14:19:55 +00:00
|
|
|
|
```
|
|
|
|
|
```go
|
2018-07-05 13:01:25 +00:00
|
|
|
|
func (c *Client) UserUpdateQuota(name string, quota string) error
|
|
|
|
|
```
|
2018-07-05 14:15:51 +00:00
|
|
|
|
Groups
|
|
|
|
|
```go
|
|
|
|
|
func (c *Client) UserGroupList(name string) ([]string, error)
|
|
|
|
|
```
|
|
|
|
|
```go
|
|
|
|
|
func (c *Client) UserGroupAdd(name string, group string) error
|
|
|
|
|
```
|
|
|
|
|
```go
|
|
|
|
|
func (c *Client) UserGroupRemove(name string, group string) error
|
|
|
|
|
```
|
|
|
|
|
```go
|
|
|
|
|
func (c *Client) UserGroupPromote(name string, group string) error
|
|
|
|
|
```
|
|
|
|
|
```go
|
|
|
|
|
func (c *Client) UserGroupDemote(name string, group string) error
|
|
|
|
|
```
|
|
|
|
|
```go
|
|
|
|
|
func (c *Client) UserGroupSubAdminList(name string) ([]string, error)
|
|
|
|
|
```
|
|
|
|
|
Welcome Mail
|
|
|
|
|
```go
|
|
|
|
|
func (c *Client) UserSendWelcomeEmail(name string) error
|
|
|
|
|
```
|
2018-07-05 10:50:56 +00:00
|
|
|
|
## Groups
|
|
|
|
|
TODO
|
|
|
|
|
|
|
|
|
|
## Apps
|
|
|
|
|
TODO
|