tapis-apps 0.3.0

The Tapis Applications API provides for management of Tapis applications including permissions.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

# \SharingApi

All URIs are relative to *http://localhost:8080*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_share_info**](SharingApi.md#get_share_info) | **GET** /v3/apps/share/{appId} | Retrieve all sharing information for an app
[**share_app**](SharingApi.md#share_app) | **POST** /v3/apps/share/{appId} | Share an app with one or more users.
[**share_app_public**](SharingApi.md#share_app_public) | **POST** /v3/apps/share_public/{appId} | Share an app publicly with all users in the tenant.
[**un_share_app**](SharingApi.md#un_share_app) | **POST** /v3/apps/unshare/{appId} | Unshare an app with one or more users.
[**un_share_app_public**](SharingApi.md#un_share_app_public) | **POST** /v3/apps/unshare_public/{appId} | Remove public access for an app.



## get_share_info

> models::RespShareInfo get_share_info(app_id)
Retrieve all sharing information for an app

Retrieve all sharing information for an app. This includes all users with whom the app has been shared and whether or not the app has been made publicly available. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_id** | **String** |  | [required] |

### Return type

[**models::RespShareInfo**](RespShareInfo.md)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## share_app

> models::RespBasic share_app(app_id, req_share_update)
Share an app with one or more users.

Create or update sharing information for an app. The app will be shared with the list of users provided in the request body. Requester must be owner of the app. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_id** | **String** |  | [required] |
**req_share_update** | [**ReqShareUpdate**](ReqShareUpdate.md) | A JSON object specifying updated sharing information. | [required] |

### Return type

[**models::RespBasic**](RespBasic.md)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## share_app_public

> models::RespBasic share_app_public(app_id)
Share an app publicly with all users in the tenant.

Share an app with all users in the tenant. Requester must be owner of the app. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_id** | **String** |  | [required] |

### Return type

[**models::RespBasic**](RespBasic.md)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## un_share_app

> models::RespBasic un_share_app(app_id, req_share_update)
Unshare an app with one or more users.

Create or update sharing information for an app. The app will be unshared with the list of users provided in the request body. Requester must be owner of the app. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_id** | **String** |  | [required] |
**req_share_update** | [**ReqShareUpdate**](ReqShareUpdate.md) | A JSON object specifying updated sharing information. | [required] |

### Return type

[**models::RespBasic**](RespBasic.md)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## un_share_app_public

> models::RespBasic un_share_app_public(app_id)
Remove public access for an app.

Remove public sharing for an app. Requester must be owner of the app. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_id** | **String** |  | [required] |

### Return type

[**models::RespBasic**](RespBasic.md)

### Authorization

[TapisJWT](../README.md#TapisJWT)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)