blob: 77c27398217a682ec14a6bcc5514e3b8caae7511 [file] [log] [blame] [view]
# airflow_client.client.UserApi
All URIs are relative to */api/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_user**](UserApi.md#delete_user) | **DELETE** /users/{username} | Delete a user
[**get_user**](UserApi.md#get_user) | **GET** /users/{username} | Get a user
[**get_users**](UserApi.md#get_users) | **GET** /users | List users
[**patch_user**](UserApi.md#patch_user) | **PATCH** /users/{username} | Update a user
[**post_user**](UserApi.md#post_user) | **POST** /users | Create a user
# **delete_user**
> delete_user(username)
Delete a user
Delete a user with a specific username. *This API endpoint is deprecated, please use the endpoint `/auth/fab/v1` for this operation instead.*
### Example
* Basic Authentication (Basic):
```python
import time
import airflow_client.client
from airflow_client.client.api import user_api
from airflow_client.client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = airflow_client.client.Configuration(
host = "/api/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure HTTP basic authorization: Basic
configuration = airflow_client.client.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Enter a context with an instance of the API client
with airflow_client.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = user_api.UserApi(api_client)
username = "username_example" # str | The username of the user. *New in version 2.1.0*
# example passing only required values which don't have defaults set
try:
# Delete a user
api_instance.delete_user(username)
except airflow_client.client.ApiException as e:
print("Exception when calling UserApi->delete_user: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **str**| The username of the user. *New in version 2.1.0* |
### Return type
void (empty response body)
### Authorization
[Basic](../README.md#Basic), [Kerberos](../README.md#Kerberos)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Success. | - |
**400** | Client specified an invalid argument. | - |
**401** | Request not authenticated due to missing, invalid, authentication info. | - |
**403** | Client does not have sufficient permission. | - |
**404** | A specified resource is not found. | - |
[[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_user**
> UserCollectionItem get_user(username)
Get a user
Get a user with a specific username. *This API endpoint is deprecated, please use the endpoint `/auth/fab/v1` for this operation instead.*
### Example
* Basic Authentication (Basic):
```python
import time
import airflow_client.client
from airflow_client.client.api import user_api
from airflow_client.client.model.error import Error
from airflow_client.client.model.user_collection_item import UserCollectionItem
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = airflow_client.client.Configuration(
host = "/api/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure HTTP basic authorization: Basic
configuration = airflow_client.client.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Enter a context with an instance of the API client
with airflow_client.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = user_api.UserApi(api_client)
username = "username_example" # str | The username of the user. *New in version 2.1.0*
# example passing only required values which don't have defaults set
try:
# Get a user
api_response = api_instance.get_user(username)
pprint(api_response)
except airflow_client.client.ApiException as e:
print("Exception when calling UserApi->get_user: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **str**| The username of the user. *New in version 2.1.0* |
### Return type
[**UserCollectionItem**](UserCollectionItem.md)
### Authorization
[Basic](../README.md#Basic), [Kerberos](../README.md#Kerberos)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success. | - |
**401** | Request not authenticated due to missing, invalid, authentication info. | - |
**403** | Client does not have sufficient permission. | - |
**404** | A specified resource is not found. | - |
[[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_users**
> UserCollection get_users()
List users
Get a list of users. *This API endpoint is deprecated, please use the endpoint `/auth/fab/v1` for this operation instead.*
### Example
* Basic Authentication (Basic):
```python
import time
import airflow_client.client
from airflow_client.client.api import user_api
from airflow_client.client.model.error import Error
from airflow_client.client.model.user_collection import UserCollection
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = airflow_client.client.Configuration(
host = "/api/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure HTTP basic authorization: Basic
configuration = airflow_client.client.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Enter a context with an instance of the API client
with airflow_client.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = user_api.UserApi(api_client)
limit = 100 # int | The numbers of items to return. (optional) if omitted the server will use the default value of 100
offset = 0 # int | The number of items to skip before starting to collect the result set. (optional)
order_by = "order_by_example" # str | The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order. *New in version 2.1.0* (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
# List users
api_response = api_instance.get_users(limit=limit, offset=offset, order_by=order_by)
pprint(api_response)
except airflow_client.client.ApiException as e:
print("Exception when calling UserApi->get_users: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **int**| The numbers of items to return. | [optional] if omitted the server will use the default value of 100
**offset** | **int**| The number of items to skip before starting to collect the result set. | [optional]
**order_by** | **str**| The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order. *New in version 2.1.0* | [optional]
### Return type
[**UserCollection**](UserCollection.md)
### Authorization
[Basic](../README.md#Basic), [Kerberos](../README.md#Kerberos)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success. | - |
**401** | Request not authenticated due to missing, invalid, authentication info. | - |
**403** | Client does not have sufficient permission. | - |
[[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)
# **patch_user**
> UserCollectionItem patch_user(username, user)
Update a user
Update fields for a user. *This API endpoint is deprecated, please use the endpoint `/auth/fab/v1` for this operation instead.*
### Example
* Basic Authentication (Basic):
```python
import time
import airflow_client.client
from airflow_client.client.api import user_api
from airflow_client.client.model.error import Error
from airflow_client.client.model.user import User
from airflow_client.client.model.user_collection_item import UserCollectionItem
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = airflow_client.client.Configuration(
host = "/api/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure HTTP basic authorization: Basic
configuration = airflow_client.client.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Enter a context with an instance of the API client
with airflow_client.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = user_api.UserApi(api_client)
username = "username_example" # str | The username of the user. *New in version 2.1.0*
user = User() # User |
update_mask = [
"update_mask_example",
] # [str] | The fields to update on the resource. If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields. (optional)
# example passing only required values which don't have defaults set
try:
# Update a user
api_response = api_instance.patch_user(username, user)
pprint(api_response)
except airflow_client.client.ApiException as e:
print("Exception when calling UserApi->patch_user: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Update a user
api_response = api_instance.patch_user(username, user, update_mask=update_mask)
pprint(api_response)
except airflow_client.client.ApiException as e:
print("Exception when calling UserApi->patch_user: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **str**| The username of the user. *New in version 2.1.0* |
**user** | [**User**](User.md)| |
**update_mask** | **[str]**| The fields to update on the resource. If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields. | [optional]
### Return type
[**UserCollectionItem**](UserCollectionItem.md)
### Authorization
[Basic](../README.md#Basic), [Kerberos](../README.md#Kerberos)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success. | - |
**400** | Client specified an invalid argument. | - |
**401** | Request not authenticated due to missing, invalid, authentication info. | - |
**403** | Client does not have sufficient permission. | - |
**404** | A specified resource is not found. | - |
[[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)
# **post_user**
> User post_user(user)
Create a user
Create a new user with unique username and email. *This API endpoint is deprecated, please use the endpoint `/auth/fab/v1` for this operation instead.*
### Example
* Basic Authentication (Basic):
```python
import time
import airflow_client.client
from airflow_client.client.api import user_api
from airflow_client.client.model.error import Error
from airflow_client.client.model.user import User
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = airflow_client.client.Configuration(
host = "/api/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure HTTP basic authorization: Basic
configuration = airflow_client.client.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Enter a context with an instance of the API client
with airflow_client.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = user_api.UserApi(api_client)
user = User() # User |
# example passing only required values which don't have defaults set
try:
# Create a user
api_response = api_instance.post_user(user)
pprint(api_response)
except airflow_client.client.ApiException as e:
print("Exception when calling UserApi->post_user: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**user** | [**User**](User.md)| |
### Return type
[**User**](User.md)
### Authorization
[Basic](../README.md#Basic), [Kerberos](../README.md#Kerberos)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success. | - |
**400** | Client specified an invalid argument. | - |
**401** | Request not authenticated due to missing, invalid, authentication info. | - |
**403** | Client does not have sufficient permission. | - |
**409** | An existing resource conflicts with the request. | - |
[[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)