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

# \PermissionsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_user_perms**](PermissionsApi.md#get_user_perms) | **GET** /v3/apps/perms/{appId}/user/{userName} | 
[**grant_user_perms**](PermissionsApi.md#grant_user_perms) | **POST** /v3/apps/perms/{appId}/user/{userName} | 
[**revoke_user_perm**](PermissionsApi.md#revoke_user_perm) | **DELETE** /v3/apps/perms/{appId}/user/{userName}/{permission} | 
[**revoke_user_perms**](PermissionsApi.md#revoke_user_perms) | **POST** /v3/apps/perms/{appId}/user/{userName}/revoke | 



## get_user_perms

> models::RespNameArray get_user_perms(app_id, user_name)


Retrieve all application related permissions for a given application and user. 

### Parameters


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

### Return type

[**models::RespNameArray**](RespNameArray.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)


## grant_user_perms

> models::RespBasic grant_user_perms(app_id, user_name, req_perms)


Create permissions in the Security Kernel for a user. Requester must be owner. Permissions are READ, MODIFY, EXECUTE. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_id** | **String** |  | [required] |
**user_name** | **String** |  | [required] |
**req_perms** | [**ReqPerms**](ReqPerms.md) | A JSON object specifying a list of permissions. | [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)


## revoke_user_perm

> models::RespBasic revoke_user_perm(app_id, user_name, permission)


Remove user permission from the Security Kernel. Requester must be owner. Permissions are READ, MODIFY, EXECUTE. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_id** | **String** |  | [required] |
**user_name** | **String** |  | [required] |
**permission** | **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)


## revoke_user_perms

> models::RespBasic revoke_user_perms(app_id, user_name, req_perms)


Remove permissions from the Security Kernel for a user. Requester must be owner. Permissions are READ, MODIFY, EXECUTE. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_id** | **String** |  | [required] |
**user_name** | **String** |  | [required] |
**req_perms** | [**ReqPerms**](ReqPerms.md) | A JSON object specifying a list of permissions. | [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)