scaleway_api_rs 0.1.8

Generated library to interact with Scaleway API.
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

# \ApiKeysApi

All URIs are relative to *https://api.scaleway.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_api_key**](ApiKeysApi.md#create_api_key) | **POST** /iam/v1alpha1/api-keys | Create an API key
[**delete_api_key**](ApiKeysApi.md#delete_api_key) | **DELETE** /iam/v1alpha1/api-keys/{access_key} | Delete an API key
[**get_api_key**](ApiKeysApi.md#get_api_key) | **GET** /iam/v1alpha1/api-keys/{access_key} | Get an API key
[**list_api_keys**](ApiKeysApi.md#list_api_keys) | **GET** /iam/v1alpha1/api-keys | List API keys
[**update_api_key**](ApiKeysApi.md#update_api_key) | **PATCH** /iam/v1alpha1/api-keys/{access_key} | Update an API key



## create_api_key

> crate::models::ScalewayPeriodIamPeriodV1alpha1PeriodApiKey create_api_key(create_api_key_request)
Create an API key

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_api_key_request** | [**CreateApiKeyRequest**](CreateApiKeyRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodIamPeriodV1alpha1PeriodApiKey**](scaleway.iam.v1alpha1.APIKey.md)

### Authorization

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

### 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)


## delete_api_key

> delete_api_key(access_key)
Delete an API key

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**access_key** | **String** | Access key to delete | [required] |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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_api_key

> crate::models::ScalewayPeriodIamPeriodV1alpha1PeriodApiKey get_api_key(access_key)
Get an API key

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**access_key** | **String** | Access key to search for | [required] |

### Return type

[**crate::models::ScalewayPeriodIamPeriodV1alpha1PeriodApiKey**](scaleway.iam.v1alpha1.APIKey.md)

### Authorization

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

### 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_api_keys

> crate::models::ScalewayPeriodIamPeriodV1alpha1PeriodListApiKeysResponse list_api_keys(organization_id, order_by, page, page_size, application_id, user_id, editable, expired, access_key, description, bearer_id, bearer_type)
List API keys

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**organization_id** | Option<**String**> | ID of organization | [required] |
**order_by** | Option<**String**> | Criteria for sorting results |  |[default to created_at_asc]
**page** | Option<**i32**> | Number of page. Value must be greater or equals to 1 |  |
**page_size** | Option<**i32**> | Number of results per page. Value must be between 1 and 100 |  |
**application_id** | Option<**String**> | ID of an application bearer |  |
**user_id** | Option<**String**> | ID of a user bearer |  |
**editable** | Option<**bool**> | Filter out editable API keys or not |  |
**expired** | Option<**bool**> | Filter out expired API keys or not |  |
**access_key** | Option<**String**> | Filter out by access key |  |
**description** | Option<**String**> | Filter out by description |  |
**bearer_id** | Option<**String**> | Filter out by bearer ID |  |
**bearer_type** | Option<**String**> | Filter out by type of bearer |  |[default to unknown_bearer_type]

### Return type

[**crate::models::ScalewayPeriodIamPeriodV1alpha1PeriodListApiKeysResponse**](scaleway.iam.v1alpha1.ListAPIKeysResponse.md)

### Authorization

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

### 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_api_key

> crate::models::ScalewayPeriodIamPeriodV1alpha1PeriodApiKey update_api_key(access_key, update_api_key_request)
Update an API key

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**access_key** | **String** | Access key to update | [required] |
**update_api_key_request** | [**UpdateApiKeyRequest**](UpdateApiKeyRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodIamPeriodV1alpha1PeriodApiKey**](scaleway.iam.v1alpha1.APIKey.md)

### Authorization

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

### 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)