142 lines
3.6 KiB
Markdown
142 lines
3.6 KiB
Markdown
# manager_api_new.api.ApiKeyApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *https://localhost:5001*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**apiKeyCreateApiKey**](ApiKeyApi.md#apikeycreateapikey) | **POST** /api/ApiKey |
|
|
[**apiKeyGetApiKeys**](ApiKeyApi.md#apikeygetapikeys) | **GET** /api/ApiKey |
|
|
[**apiKeyRevokeApiKey**](ApiKeyApi.md#apikeyrevokeapikey) | **DELETE** /api/ApiKey/{id} |
|
|
|
|
|
|
# **apiKeyCreateApiKey**
|
|
> MultipartFile apiKeyCreateApiKey(createApiKeyRequest)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = ApiKeyApi();
|
|
final createApiKeyRequest = CreateApiKeyRequest(); // CreateApiKeyRequest |
|
|
|
|
try {
|
|
final result = api_instance.apiKeyCreateApiKey(createApiKeyRequest);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ApiKeyApi->apiKeyCreateApiKey: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**createApiKeyRequest** | [**CreateApiKeyRequest**](CreateApiKeyRequest.md)| |
|
|
|
|
### Return type
|
|
|
|
[**MultipartFile**](MultipartFile.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/octet-stream
|
|
|
|
[[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)
|
|
|
|
# **apiKeyGetApiKeys**
|
|
> MultipartFile apiKeyGetApiKeys()
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = ApiKeyApi();
|
|
|
|
try {
|
|
final result = api_instance.apiKeyGetApiKeys();
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ApiKeyApi->apiKeyGetApiKeys: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**MultipartFile**](MultipartFile.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/octet-stream
|
|
|
|
[[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)
|
|
|
|
# **apiKeyRevokeApiKey**
|
|
> MultipartFile apiKeyRevokeApiKey(id)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = ApiKeyApi();
|
|
final id = id_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.apiKeyRevokeApiKey(id);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ApiKeyApi->apiKeyRevokeApiKey: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **String**| |
|
|
|
|
### Return type
|
|
|
|
[**MultipartFile**](MultipartFile.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/octet-stream
|
|
|
|
[[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)
|
|
|