24 KiB
\SharingApi
All URIs are relative to https://localhost/api/v1
Method | HTTP request | Description |
---|---|---|
ListsIdTeamsGet | Get /lists/{id}/teams | Get teams on a list |
ListsIdTeamsPut | Put /lists/{id}/teams | Add a team to a list |
ListsIdUsersGet | Get /lists/{id}/users | Get users on a list |
ListsIdUsersPut | Put /lists/{id}/users | Add a user to a list |
ListsListIDTeamsTeamIDDelete | Delete /lists/{listID}/teams/{teamID} | Delete a team from a list |
ListsListIDTeamsTeamIDPost | Post /lists/{listID}/teams/{teamID} | Update a team <-> list relation |
ListsListIDUsersUserIDDelete | Delete /lists/{listID}/users/{userID} | Delete a user from a list |
ListsListIDUsersUserIDPost | Post /lists/{listID}/users/{userID} | Update a user <-> list relation |
ListsListSharesGet | Get /lists/{list}/shares | Get all link shares for a list |
ListsListSharesPut | Put /lists/{list}/shares | Share a list via link |
ListsListSharesShareDelete | Delete /lists/{list}/shares/{share} | Remove a link share |
ListsListSharesShareGet | Get /lists/{list}/shares/{share} | Get one link shares for a list |
NamespacesIdTeamsGet | Get /namespaces/{id}/teams | Get teams on a namespace |
NamespacesIdTeamsPut | Put /namespaces/{id}/teams | Add a team to a namespace |
NamespacesIdUsersGet | Get /namespaces/{id}/users | Get users on a namespace |
NamespacesIdUsersPut | Put /namespaces/{id}/users | Add a user to a namespace |
NamespacesNamespaceIDTeamsTeamIDDelete | Delete /namespaces/{namespaceID}/teams/{teamID} | Delete a team from a namespace |
NamespacesNamespaceIDTeamsTeamIDPost | Post /namespaces/{namespaceID}/teams/{teamID} | Update a team <-> namespace relation |
NamespacesNamespaceIDUsersUserIDDelete | Delete /namespaces/{namespaceID}/users/{userID} | Delete a user from a namespace |
NamespacesNamespaceIDUsersUserIDPost | Post /namespaces/{namespaceID}/users/{userID} | Update a user <-> namespace relation |
SharesShareAuthPost | Post /shares/{share}/auth | Get an auth token for a share |
ListsIdTeamsGet
[]ModelsTeamWithRight ListsIdTeamsGet(ctx, id, optional) Get teams on a list
Returns a list with all teams which have access on a given list.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
id | int32 | List ID | |
optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a map[string]interface{}.
Name | Type | Description | Notes |
---|---|---|---|
id | int32 | List ID | |
p | int32 | The page number. Used for pagination. If not provided, the first page of results is returned. | |
s | string | Search teams by its name. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListsIdTeamsPut
ModelsTeamList ListsIdTeamsPut(ctx, id, list) Add a team to a list
Gives a team access to a list.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
id | int32 | List ID | |
list | ModelsTeamList | The team you want to add to the list. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListsIdUsersGet
[]ModelsUserWithRight ListsIdUsersGet(ctx, id, optional) Get users on a list
Returns a list with all users which have access on a given list.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
id | int32 | List ID | |
optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a map[string]interface{}.
Name | Type | Description | Notes |
---|---|---|---|
id | int32 | List ID | |
p | int32 | The page number. Used for pagination. If not provided, the first page of results is returned. | |
s | string | Search users by its name. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListsIdUsersPut
ModelsListUser ListsIdUsersPut(ctx, id, list) Add a user to a list
Gives a user access to a list.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
id | int32 | List ID | |
list | ModelsListUser | The user you want to add to the list. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListsListIDTeamsTeamIDDelete
ModelsMessage ListsListIDTeamsTeamIDDelete(ctx, listID, teamID) Delete a team from a list
Delets a team from a list. The team won't have access to the list anymore.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
listID | int32 | List ID | |
teamID | int32 | Team ID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListsListIDTeamsTeamIDPost
ModelsTeamList ListsListIDTeamsTeamIDPost(ctx, listID, teamID, list) Update a team <-> list relation
Update a team <-> list relation. Mostly used to update the right that team has.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
listID | int32 | List ID | |
teamID | int32 | Team ID | |
list | ModelsTeamList | The team you want to update. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListsListIDUsersUserIDDelete
ModelsMessage ListsListIDUsersUserIDDelete(ctx, listID, userID) Delete a user from a list
Delets a user from a list. The user won't have access to the list anymore.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
listID | int32 | List ID | |
userID | int32 | User ID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListsListIDUsersUserIDPost
ModelsListUser ListsListIDUsersUserIDPost(ctx, listID, userID, list) Update a user <-> list relation
Update a user <-> list relation. Mostly used to update the right that user has.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
listID | int32 | List ID | |
userID | int32 | User ID | |
list | ModelsListUser | The user you want to update. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListsListSharesGet
[]ModelsLinkSharing ListsListSharesGet(ctx, list, optional) Get all link shares for a list
Returns all link shares which exist for a given list
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
list | int32 | List ID | |
optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a map[string]interface{}.
Name | Type | Description | Notes |
---|---|---|---|
list | int32 | List ID | |
p | int32 | The page number. Used for pagination. If not provided, the first page of results is returned. | |
s | string | Search shares by hash. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListsListSharesPut
ModelsLinkSharing ListsListSharesPut(ctx, list, label) Share a list via link
Share a list via link. The user needs to have write-access to the list to be able do this.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
list | int32 | List ID | |
label | ModelsLinkSharing | The new link share object |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListsListSharesShareDelete
ModelsMessage ListsListSharesShareDelete(ctx, list, share) Remove a link share
Remove a link share. The user needs to have write-access to the list to be able do this.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
list | int32 | List ID | |
share | int32 | Share Link ID |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListsListSharesShareGet
ModelsLinkSharing ListsListSharesShareGet(ctx, list, share) Get one link shares for a list
Returns one link share by its ID.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
list | int32 | List ID | |
share | int32 | Share ID |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NamespacesIdTeamsGet
[]ModelsTeamWithRight NamespacesIdTeamsGet(ctx, id, optional) Get teams on a namespace
Returns a namespace with all teams which have access on a given namespace.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
id | int32 | Namespace ID | |
optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a map[string]interface{}.
Name | Type | Description | Notes |
---|---|---|---|
id | int32 | Namespace ID | |
p | int32 | The page number. Used for pagination. If not provided, the first page of results is returned. | |
s | string | Search teams by its name. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NamespacesIdTeamsPut
ModelsTeamNamespace NamespacesIdTeamsPut(ctx, id, namespace) Add a team to a namespace
Gives a team access to a namespace.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
id | int32 | Namespace ID | |
namespace | ModelsTeamNamespace | The team you want to add to the namespace. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NamespacesIdUsersGet
[]ModelsUserWithRight NamespacesIdUsersGet(ctx, id, optional) Get users on a namespace
Returns a namespace with all users which have access on a given namespace.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
id | int32 | Namespace ID | |
optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a map[string]interface{}.
Name | Type | Description | Notes |
---|---|---|---|
id | int32 | Namespace ID | |
p | int32 | The page number. Used for pagination. If not provided, the first page of results is returned. | |
s | string | Search users by its name. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NamespacesIdUsersPut
ModelsNamespaceUser NamespacesIdUsersPut(ctx, id, namespace) Add a user to a namespace
Gives a user access to a namespace.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
id | int32 | Namespace ID | |
namespace | ModelsNamespaceUser | The user you want to add to the namespace. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NamespacesNamespaceIDTeamsTeamIDDelete
ModelsMessage NamespacesNamespaceIDTeamsTeamIDDelete(ctx, namespaceID, teamID) Delete a team from a namespace
Delets a team from a namespace. The team won't have access to the namespace anymore.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
namespaceID | int32 | Namespace ID | |
teamID | int32 | team ID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NamespacesNamespaceIDTeamsTeamIDPost
ModelsTeamNamespace NamespacesNamespaceIDTeamsTeamIDPost(ctx, namespaceID, teamID, namespace) Update a team <-> namespace relation
Update a team <-> namespace relation. Mostly used to update the right that team has.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
namespaceID | int32 | Namespace ID | |
teamID | int32 | Team ID | |
namespace | ModelsTeamNamespace | The team you want to update. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NamespacesNamespaceIDUsersUserIDDelete
ModelsMessage NamespacesNamespaceIDUsersUserIDDelete(ctx, namespaceID, userID) Delete a user from a namespace
Delets a user from a namespace. The user won't have access to the namespace anymore.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
namespaceID | int32 | Namespace ID | |
userID | int32 | user ID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NamespacesNamespaceIDUsersUserIDPost
ModelsNamespaceUser NamespacesNamespaceIDUsersUserIDPost(ctx, namespaceID, userID, namespace) Update a user <-> namespace relation
Update a user <-> namespace relation. Mostly used to update the right that user has.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
namespaceID | int32 | Namespace ID | |
userID | int32 | User ID | |
namespace | ModelsNamespaceUser | The user you want to update. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SharesShareAuthPost
V1Token SharesShareAuthPost(ctx, share) Get an auth token for a share
Get a jwt auth token for a shared list from a share hash.
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for logging, tracing, authentication, etc. | |
share | string | The share hash |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]