tapis-workflows 0.3.1

Create and manage pipelines
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
166
167
168

# \UsersApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_group_user**](UsersApi.md#add_group_user) | **POST** /v3/workflows/groups/{group_id}/users | Add a user to a group
[**get_group_user**](UsersApi.md#get_group_user) | **GET** /v3/workflows/groups/{group_id}/users/{username} | Get group user
[**list_group_users**](UsersApi.md#list_group_users) | **GET** /v3/workflows/groups/{group_id}/users | List users
[**remove_group_user**](UsersApi.md#remove_group_user) | **DELETE** /v3/workflows/groups/{group_id}/users/{username} | Remove user from group
[**update_group_user**](UsersApi.md#update_group_user) | **PATCH** /v3/workflows/groups/{group_id}/users/{username} | Update group user



## add_group_user

> models::RespResourceUrl add_group_user(group_id, req_group_user)
Add a user to a group

Add a user to a group. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** |  | [required] |
**req_group_user** | [**ReqGroupUser**](ReqGroupUser.md) | A JSON object specifying the group user to add. | [required] |

### Return type

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


## get_group_user

> models::RespGroupUser get_group_user(group_id, username)
Get group user

Get a user from a group 

### Parameters


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

### Return type

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


## list_group_users

> models::RespGroupUserList list_group_users(group_id)
List users

List users. 

### Parameters


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

### Return type

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


## remove_group_user

> models::RespGroupUser remove_group_user(group_id, username)
Remove user from group

Remove a user from a group. 

### Parameters


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

### Return type

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


## update_group_user

> models::RespGroupUser update_group_user(group_id, username, req_update_group_user)
Update group user

Update a user for a specified group. Only group admins can perform this operation. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** |  | [required] |
**username** | **String** |  | [required] |
**req_update_group_user** | [**ReqUpdateGroupUser**](ReqUpdateGroupUser.md) | A JSON object | [required] |

### Return type

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