deprecated-oc-catalog/selfapi/docs/UserApi.md

64 lines
1.6 KiB
Markdown
Raw Normal View History

2023-03-03 14:43:11 +01:00
# \UserApi
All URIs are relative to *https://localhost:49618/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**UserControllerLogin**](UserApi.md#UserControllerLogin) | **Get** /user/login |
[**UserControllerLogout**](UserApi.md#UserControllerLogout) | **Get** /user/logout |
# **UserControllerLogin**
> UserControllerLogin(ctx, username, password)
Logs user into the system
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**username** | **string**| The username for login |
**password** | **string**| The password for login |
### Return type
(empty response body)
### Authorization
No authorization required
### 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)
# **UserControllerLogout**
> UserControllerLogout(ctx, )
Logs out current logged in user session
### Required Parameters
This endpoint does not need any parameter.
### Return type
(empty response body)
### Authorization
No authorization required
### 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)