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

# \GroupSecretsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_group_secret**](GroupSecretsApi.md#add_group_secret) | **POST** /v3/workflows/groups/{group_id}/secrets | Add a user's secret to a group
[**get_group_secret**](GroupSecretsApi.md#get_group_secret) | **GET** /v3/workflows/groups/{group_id}/secrets/{group_secret_id} | Get group secret
[**list_group_secrets**](GroupSecretsApi.md#list_group_secrets) | **GET** /v3/workflows/groups/{group_id}/secrets | List group secrets
[**remove_group_secret**](GroupSecretsApi.md#remove_group_secret) | **DELETE** /v3/workflows/groups/{group_id}/secrets/{group_secret_id} | Remove user from group



## add_group_secret

> models::RespGroupSecret add_group_secret(group_id, req_group_secret)
Add a user's secret to a group

Add a user's secret to a group. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**group_id** | **String** |  | [required] |
**req_group_secret** | [**ReqGroupSecret**](ReqGroupSecret.md) | A JSON object specifying the GroupSecret to add. | [required] |

### Return type

[**models::RespGroupSecret**](RespGroupSecret.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_secret

> models::RespGroupSecret get_group_secret(group_id, group_secret_id)
Get group secret

Get a group secret 

### Parameters


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

### Return type

[**models::RespGroupSecret**](RespGroupSecret.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_secrets

> models::RespGroupSecretList list_group_secrets(group_id)
List group secrets

List group_secrets. 

### Parameters


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

### Return type

[**models::RespGroupSecretList**](RespGroupSecretList.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_secret

> models::RespBase remove_group_secret(group_id, group_secret_id)
Remove user from group

Remove a user from a group. 

### Parameters


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

### Return type

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