airflow_client/docs/UserApi.md - airflow-client-python - Git at Google

 <!--
  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing,
  software distributed under the License is distributed on an
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, either express or implied.  See the License for the
  specific language governing permissions and limitations
  under the License.
  -->

 # Apache Airflow Python Client.UserApi

 All URIs are relative to *http://localhost/api/v1*

 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_user**](UserApi.md#get_user) | **GET** /users/{username} | Get a user
 [**get_users**](UserApi.md#get_users) | **GET** /users | List users


 # **get_user**
 > UserCollectionItem get_user(username)

 Get a user

 ### Example

 * Basic Authentication (Basic):
 ```python
 import time
 import airflow_client.client
 from airflow_client.client.api import user_api
 from airflow_client.client.model.user_collection_item import UserCollectionItem
 from airflow_client.client.model.error import Error
 from pprint import pprint
 # Defining the host is optional and defaults to http://localhost/api/v1
 # See configuration.py for a list of all supported configuration parameters.
 configuration = client.Configuration(
     host = "http://localhost/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 = client.Configuration(
     username = 'YOUR_USERNAME',
     password = 'YOUR_PASSWORD'
 )

 # Enter a context with an instance of the API client
 with 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

     # 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 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 |

 ### 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

 ### Example

 * Basic Authentication (Basic):
 ```python
 import time
 import airflow_client.client
 from airflow_client.client.api import user_api
 from airflow_client.client.model.user_collection import UserCollection
 from airflow_client.client.model.error import Error
 from pprint import pprint
 # Defining the host is optional and defaults to http://localhost/api/v1
 # See configuration.py for a list of all supported configuration parameters.
 configuration = client.Configuration(
     host = "http://localhost/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 = client.Configuration(
     username = 'YOUR_USERNAME',
     password = 'YOUR_PASSWORD'
 )

 # Enter a context with an instance of the API client
 with 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)

     # 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)
         pprint(api_response)
     except 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]

 ### 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)
	<!--
	Licensed to the Apache Software Foundation (ASF) under one
	or more contributor license agreements. See the NOTICE file
	distributed with this work for additional information
	regarding copyright ownership. The ASF licenses this file
	to you under the Apache License, Version 2.0 (the
	"License"); you may not use this file except in compliance
	with the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing,
	software distributed under the License is distributed on an
	"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	KIND, either express or implied. See the License for the
	specific language governing permissions and limitations
	under the License.
	-->

	# Apache Airflow Python Client.UserApi

	All URIs are relative to http://localhost/api/v1

	Method \| HTTP request \| Description
	------------- \| ------------- \| -------------
	[get_user](UserApi.md#get_user) \| GET /users/{username} \| Get a user
	[get_users](UserApi.md#get_users) \| GET /users \| List users


	# get_user
	> UserCollectionItem get_user(username)

	Get a user

	### Example

	* Basic Authentication (Basic):
	```python
	import time
	import airflow_client.client
	from airflow_client.client.api import user_api
	from airflow_client.client.model.user_collection_item import UserCollectionItem
	from airflow_client.client.model.error import Error
	from pprint import pprint
	# Defining the host is optional and defaults to http://localhost/api/v1
	# See configuration.py for a list of all supported configuration parameters.
	configuration = client.Configuration(
	host = "http://localhost/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 = client.Configuration(
	username = 'YOUR_USERNAME',
	password = 'YOUR_PASSWORD'
	)

	# Enter a context with an instance of the API client
	with 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

	# 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 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 \|

	### 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

	### Example

	* Basic Authentication (Basic):
	```python
	import time
	import airflow_client.client
	from airflow_client.client.api import user_api
	from airflow_client.client.model.user_collection import UserCollection
	from airflow_client.client.model.error import Error
	from pprint import pprint
	# Defining the host is optional and defaults to http://localhost/api/v1
	# See configuration.py for a list of all supported configuration parameters.
	configuration = client.Configuration(
	host = "http://localhost/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 = client.Configuration(
	username = 'YOUR_USERNAME',
	password = 'YOUR_PASSWORD'
	)

	# Enter a context with an instance of the API client
	with 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)

	# 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)
	pprint(api_response)
	except 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]

	### 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)