You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
100 lines
2.5 KiB
100 lines
2.5 KiB
2 years ago
|
# openapi.api.DefaultApi
|
||
|
|
|
||
|
|
## Load the API package
|
||
|
|
```dart
|
||
|
|
import 'package:openapi/api.dart';
|
||
|
|
```
|
||
|
|
|
||
|
|
All URIs are relative to *https://localhost:8080/ocs/v1.php/cloud*
|
||
|
|
|
||
|
|
Method | HTTP request | Description
|
||
|
|
------------- | ------------- | -------------
|
||
|
|
[**getCurrentUser**](DefaultApi.md#getcurrentuser) | **GET** /user |
|
||
|
|
[**getUser**](DefaultApi.md#getuser) | **GET** /users/{userId} |
|
||
|
|
|
||
|
|
|
||
|
|
# **getCurrentUser**
|
||
|
|
> ProvisioningApiUser getCurrentUser()
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Example
|
||
|
|
```dart
|
||
|
|
import 'package:openapi/api.dart';
|
||
|
|
// TODO Configure HTTP basic authorization: basic_auth
|
||
|
|
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME'
|
||
|
|
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD';
|
||
|
|
|
||
|
|
final api_instance = DefaultApi();
|
||
|
|
|
||
|
|
try {
|
||
|
|
final result = api_instance.getCurrentUser();
|
||
|
|
print(result);
|
||
|
|
} catch (e) {
|
||
|
|
print('Exception when calling DefaultApi->getCurrentUser: $e\n');
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
This endpoint does not need any parameter.
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**ProvisioningApiUser**](ProvisioningApiUser.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[basic_auth](../README.md#basic_auth)
|
||
|
|
|
||
|
|
### 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)
|
||
|
|
|
||
|
|
# **getUser**
|
||
|
|
> ProvisioningApiUser getUser(userId)
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Example
|
||
|
|
```dart
|
||
|
|
import 'package:openapi/api.dart';
|
||
|
|
// TODO Configure HTTP basic authorization: basic_auth
|
||
|
|
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME'
|
||
|
|
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD';
|
||
|
|
|
||
|
|
final api_instance = DefaultApi();
|
||
|
|
final userId = userId_example; // String |
|
||
|
|
|
||
|
|
try {
|
||
|
|
final result = api_instance.getUser(userId);
|
||
|
|
print(result);
|
||
|
|
} catch (e) {
|
||
|
|
print('Exception when calling DefaultApi->getUser: $e\n');
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Name | Type | Description | Notes
|
||
|
|
------------- | ------------- | ------------- | -------------
|
||
|
|
**userId** | **String**| |
|
||
|
|
|
||
|
|
### Return type
|
||
|
|
|
||
|
|
[**ProvisioningApiUser**](ProvisioningApiUser.md)
|
||
|
|
|
||
|
|
### Authorization
|
||
|
|
|
||
|
|
[basic_auth](../README.md#basic_auth)
|
||
|
|
|
||
|
|
### 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)
|
||
|
|
|