494 lines
18 KiB
Markdown
494 lines
18 KiB
Markdown
# UserApi
|
|
|
|
All URIs are relative to *http://localhost/*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**createUser**](UserApi.md#createUser) | **POST** user | Create a user.
|
|
[**currentUser**](UserApi.md#currentUser) | **GET** current/user | Return the current user.
|
|
[**deleteUser**](UserApi.md#deleteUser) | **DELETE** user/{id} | Deletes a user.
|
|
[**getUser**](UserApi.md#getUser) | **GET** user/{id} | Get a user.
|
|
[**getUsers**](UserApi.md#getUsers) | **GET** user | Return all users.
|
|
[**updateCurrentUser**](UserApi.md#updateCurrentUser) | **POST** current/user/password | Update the password of the current user.
|
|
[**updateUser**](UserApi.md#updateUser) | **POST** user/{id} | Update a user.
|
|
|
|
<a name="createUser"></a>
|
|
# **createUser**
|
|
> User createUser(body)
|
|
|
|
Create a user.
|
|
|
|
With enabled registration: non admin users can be created without authentication. With disabled registrations: users can only be created by admin users.
|
|
|
|
### Example
|
|
```java
|
|
// Import classes:
|
|
//import com.github.gotify.client.ApiClient;
|
|
//import com.github.gotify.client.ApiException;
|
|
//import com.github.gotify.client.Configuration;
|
|
//import com.github.gotify.client.auth.*;
|
|
//import com.github.gotify.client.api.UserApi;
|
|
|
|
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
|
// Configure HTTP basic authorization: basicAuth
|
|
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
|
|
basicAuth.setUsername("YOUR USERNAME");
|
|
basicAuth.setPassword("YOUR PASSWORD");
|
|
|
|
// Configure API key authorization: clientTokenAuthorizationHeader
|
|
ApiKeyAuth clientTokenAuthorizationHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenAuthorizationHeader");
|
|
clientTokenAuthorizationHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenAuthorizationHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenHeader
|
|
ApiKeyAuth clientTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenHeader");
|
|
clientTokenHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenQuery
|
|
ApiKeyAuth clientTokenQuery = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenQuery");
|
|
clientTokenQuery.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenQuery.setApiKeyPrefix("Token");
|
|
|
|
UserApi apiInstance = new UserApi();
|
|
CreateUserExternal body = new CreateUserExternal(); // CreateUserExternal | the user to add
|
|
try {
|
|
User result = apiInstance.createUser(body);
|
|
System.out.println(result);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling UserApi#createUser");
|
|
e.printStackTrace();
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**body** | [**CreateUserExternal**](CreateUserExternal.md)| the user to add |
|
|
|
|
### Return type
|
|
|
|
[**User**](User.md)
|
|
|
|
### Authorization
|
|
|
|
[basicAuth](../README.md#basicAuth)[clientTokenAuthorizationHeader](../README.md#clientTokenAuthorizationHeader)[clientTokenHeader](../README.md#clientTokenHeader)[clientTokenQuery](../README.md#clientTokenQuery)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
<a name="currentUser"></a>
|
|
# **currentUser**
|
|
> User currentUser()
|
|
|
|
Return the current user.
|
|
|
|
### Example
|
|
```java
|
|
// Import classes:
|
|
//import com.github.gotify.client.ApiClient;
|
|
//import com.github.gotify.client.ApiException;
|
|
//import com.github.gotify.client.Configuration;
|
|
//import com.github.gotify.client.auth.*;
|
|
//import com.github.gotify.client.api.UserApi;
|
|
|
|
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
|
// Configure HTTP basic authorization: basicAuth
|
|
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
|
|
basicAuth.setUsername("YOUR USERNAME");
|
|
basicAuth.setPassword("YOUR PASSWORD");
|
|
|
|
// Configure API key authorization: clientTokenAuthorizationHeader
|
|
ApiKeyAuth clientTokenAuthorizationHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenAuthorizationHeader");
|
|
clientTokenAuthorizationHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenAuthorizationHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenHeader
|
|
ApiKeyAuth clientTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenHeader");
|
|
clientTokenHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenQuery
|
|
ApiKeyAuth clientTokenQuery = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenQuery");
|
|
clientTokenQuery.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenQuery.setApiKeyPrefix("Token");
|
|
|
|
UserApi apiInstance = new UserApi();
|
|
try {
|
|
User result = apiInstance.currentUser();
|
|
System.out.println(result);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling UserApi#currentUser");
|
|
e.printStackTrace();
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**User**](User.md)
|
|
|
|
### Authorization
|
|
|
|
[basicAuth](../README.md#basicAuth)[clientTokenAuthorizationHeader](../README.md#clientTokenAuthorizationHeader)[clientTokenHeader](../README.md#clientTokenHeader)[clientTokenQuery](../README.md#clientTokenQuery)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="deleteUser"></a>
|
|
# **deleteUser**
|
|
> Void deleteUser(id)
|
|
|
|
Deletes a user.
|
|
|
|
### Example
|
|
```java
|
|
// Import classes:
|
|
//import com.github.gotify.client.ApiClient;
|
|
//import com.github.gotify.client.ApiException;
|
|
//import com.github.gotify.client.Configuration;
|
|
//import com.github.gotify.client.auth.*;
|
|
//import com.github.gotify.client.api.UserApi;
|
|
|
|
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
|
// Configure HTTP basic authorization: basicAuth
|
|
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
|
|
basicAuth.setUsername("YOUR USERNAME");
|
|
basicAuth.setPassword("YOUR PASSWORD");
|
|
|
|
// Configure API key authorization: clientTokenAuthorizationHeader
|
|
ApiKeyAuth clientTokenAuthorizationHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenAuthorizationHeader");
|
|
clientTokenAuthorizationHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenAuthorizationHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenHeader
|
|
ApiKeyAuth clientTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenHeader");
|
|
clientTokenHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenQuery
|
|
ApiKeyAuth clientTokenQuery = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenQuery");
|
|
clientTokenQuery.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenQuery.setApiKeyPrefix("Token");
|
|
|
|
UserApi apiInstance = new UserApi();
|
|
Long id = 789L; // Long | the user id
|
|
try {
|
|
Void result = apiInstance.deleteUser(id);
|
|
System.out.println(result);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling UserApi#deleteUser");
|
|
e.printStackTrace();
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **Long**| the user id |
|
|
|
|
### Return type
|
|
|
|
[**Void**](.md)
|
|
|
|
### Authorization
|
|
|
|
[basicAuth](../README.md#basicAuth)[clientTokenAuthorizationHeader](../README.md#clientTokenAuthorizationHeader)[clientTokenHeader](../README.md#clientTokenHeader)[clientTokenQuery](../README.md#clientTokenQuery)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="getUser"></a>
|
|
# **getUser**
|
|
> User getUser(id)
|
|
|
|
Get a user.
|
|
|
|
### Example
|
|
```java
|
|
// Import classes:
|
|
//import com.github.gotify.client.ApiClient;
|
|
//import com.github.gotify.client.ApiException;
|
|
//import com.github.gotify.client.Configuration;
|
|
//import com.github.gotify.client.auth.*;
|
|
//import com.github.gotify.client.api.UserApi;
|
|
|
|
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
|
// Configure HTTP basic authorization: basicAuth
|
|
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
|
|
basicAuth.setUsername("YOUR USERNAME");
|
|
basicAuth.setPassword("YOUR PASSWORD");
|
|
|
|
// Configure API key authorization: clientTokenAuthorizationHeader
|
|
ApiKeyAuth clientTokenAuthorizationHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenAuthorizationHeader");
|
|
clientTokenAuthorizationHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenAuthorizationHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenHeader
|
|
ApiKeyAuth clientTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenHeader");
|
|
clientTokenHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenQuery
|
|
ApiKeyAuth clientTokenQuery = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenQuery");
|
|
clientTokenQuery.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenQuery.setApiKeyPrefix("Token");
|
|
|
|
UserApi apiInstance = new UserApi();
|
|
Long id = 789L; // Long | the user id
|
|
try {
|
|
User result = apiInstance.getUser(id);
|
|
System.out.println(result);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling UserApi#getUser");
|
|
e.printStackTrace();
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **Long**| the user id |
|
|
|
|
### Return type
|
|
|
|
[**User**](User.md)
|
|
|
|
### Authorization
|
|
|
|
[basicAuth](../README.md#basicAuth)[clientTokenAuthorizationHeader](../README.md#clientTokenAuthorizationHeader)[clientTokenHeader](../README.md#clientTokenHeader)[clientTokenQuery](../README.md#clientTokenQuery)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="getUsers"></a>
|
|
# **getUsers**
|
|
> List<User> getUsers()
|
|
|
|
Return all users.
|
|
|
|
### Example
|
|
```java
|
|
// Import classes:
|
|
//import com.github.gotify.client.ApiClient;
|
|
//import com.github.gotify.client.ApiException;
|
|
//import com.github.gotify.client.Configuration;
|
|
//import com.github.gotify.client.auth.*;
|
|
//import com.github.gotify.client.api.UserApi;
|
|
|
|
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
|
// Configure HTTP basic authorization: basicAuth
|
|
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
|
|
basicAuth.setUsername("YOUR USERNAME");
|
|
basicAuth.setPassword("YOUR PASSWORD");
|
|
|
|
// Configure API key authorization: clientTokenAuthorizationHeader
|
|
ApiKeyAuth clientTokenAuthorizationHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenAuthorizationHeader");
|
|
clientTokenAuthorizationHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenAuthorizationHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenHeader
|
|
ApiKeyAuth clientTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenHeader");
|
|
clientTokenHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenQuery
|
|
ApiKeyAuth clientTokenQuery = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenQuery");
|
|
clientTokenQuery.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenQuery.setApiKeyPrefix("Token");
|
|
|
|
UserApi apiInstance = new UserApi();
|
|
try {
|
|
List<User> result = apiInstance.getUsers();
|
|
System.out.println(result);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling UserApi#getUsers");
|
|
e.printStackTrace();
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**List<User>**](User.md)
|
|
|
|
### Authorization
|
|
|
|
[basicAuth](../README.md#basicAuth)[clientTokenAuthorizationHeader](../README.md#clientTokenAuthorizationHeader)[clientTokenHeader](../README.md#clientTokenHeader)[clientTokenQuery](../README.md#clientTokenQuery)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="updateCurrentUser"></a>
|
|
# **updateCurrentUser**
|
|
> Void updateCurrentUser(body)
|
|
|
|
Update the password of the current user.
|
|
|
|
### Example
|
|
```java
|
|
// Import classes:
|
|
//import com.github.gotify.client.ApiClient;
|
|
//import com.github.gotify.client.ApiException;
|
|
//import com.github.gotify.client.Configuration;
|
|
//import com.github.gotify.client.auth.*;
|
|
//import com.github.gotify.client.api.UserApi;
|
|
|
|
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
|
// Configure HTTP basic authorization: basicAuth
|
|
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
|
|
basicAuth.setUsername("YOUR USERNAME");
|
|
basicAuth.setPassword("YOUR PASSWORD");
|
|
|
|
// Configure API key authorization: clientTokenAuthorizationHeader
|
|
ApiKeyAuth clientTokenAuthorizationHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenAuthorizationHeader");
|
|
clientTokenAuthorizationHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenAuthorizationHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenHeader
|
|
ApiKeyAuth clientTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenHeader");
|
|
clientTokenHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenQuery
|
|
ApiKeyAuth clientTokenQuery = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenQuery");
|
|
clientTokenQuery.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenQuery.setApiKeyPrefix("Token");
|
|
|
|
UserApi apiInstance = new UserApi();
|
|
UserPass body = new UserPass(); // UserPass | the user
|
|
try {
|
|
Void result = apiInstance.updateCurrentUser(body);
|
|
System.out.println(result);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling UserApi#updateCurrentUser");
|
|
e.printStackTrace();
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**body** | [**UserPass**](UserPass.md)| the user |
|
|
|
|
### Return type
|
|
|
|
[**Void**](.md)
|
|
|
|
### Authorization
|
|
|
|
[basicAuth](../README.md#basicAuth)[clientTokenAuthorizationHeader](../README.md#clientTokenAuthorizationHeader)[clientTokenHeader](../README.md#clientTokenHeader)[clientTokenQuery](../README.md#clientTokenQuery)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
<a name="updateUser"></a>
|
|
# **updateUser**
|
|
> User updateUser(body, id)
|
|
|
|
Update a user.
|
|
|
|
### Example
|
|
```java
|
|
// Import classes:
|
|
//import com.github.gotify.client.ApiClient;
|
|
//import com.github.gotify.client.ApiException;
|
|
//import com.github.gotify.client.Configuration;
|
|
//import com.github.gotify.client.auth.*;
|
|
//import com.github.gotify.client.api.UserApi;
|
|
|
|
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
|
// Configure HTTP basic authorization: basicAuth
|
|
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
|
|
basicAuth.setUsername("YOUR USERNAME");
|
|
basicAuth.setPassword("YOUR PASSWORD");
|
|
|
|
// Configure API key authorization: clientTokenAuthorizationHeader
|
|
ApiKeyAuth clientTokenAuthorizationHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenAuthorizationHeader");
|
|
clientTokenAuthorizationHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenAuthorizationHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenHeader
|
|
ApiKeyAuth clientTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenHeader");
|
|
clientTokenHeader.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenHeader.setApiKeyPrefix("Token");
|
|
|
|
// Configure API key authorization: clientTokenQuery
|
|
ApiKeyAuth clientTokenQuery = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenQuery");
|
|
clientTokenQuery.setApiKey("YOUR API KEY");
|
|
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
|
//clientTokenQuery.setApiKeyPrefix("Token");
|
|
|
|
UserApi apiInstance = new UserApi();
|
|
UpdateUserExternal body = new UpdateUserExternal(); // UpdateUserExternal | the updated user
|
|
Long id = 789L; // Long | the user id
|
|
try {
|
|
User result = apiInstance.updateUser(body, id);
|
|
System.out.println(result);
|
|
} catch (ApiException e) {
|
|
System.err.println("Exception when calling UserApi#updateUser");
|
|
e.printStackTrace();
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**body** | [**UpdateUserExternal**](UpdateUserExternal.md)| the updated user |
|
|
**id** | **Long**| the user id |
|
|
|
|
### Return type
|
|
|
|
[**User**](User.md)
|
|
|
|
### Authorization
|
|
|
|
[basicAuth](../README.md#basicAuth)[clientTokenAuthorizationHeader](../README.md#clientTokenAuthorizationHeader)[clientTokenHeader](../README.md#clientTokenHeader)[clientTokenQuery](../README.md#clientTokenQuery)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|