You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

577 lines
21 KiB
Markdown

# cvat_sdk.UsersApi
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**users_destroy**](UsersApi.md#users_destroy) | **DELETE** /api/users/{id} | Method deletes a specific user from the server
[**users_list**](UsersApi.md#users_list) | **GET** /api/users | Method provides a paginated list of users registered on the server
[**users_partial_update**](UsersApi.md#users_partial_update) | **PATCH** /api/users/{id} | Method updates chosen fields of a user
[**users_retrieve**](UsersApi.md#users_retrieve) | **GET** /api/users/{id} | Method provides information of a specific user
[**users_retrieve_self**](UsersApi.md#users_retrieve_self) | **GET** /api/users/self | Method returns an instance of a user who is currently authorized
# **users_destroy**
> users_destroy(id)
Method deletes a specific user from the server
### Example
* Api Key Authentication (SignatureAuthentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
* Api Key Authentication (tokenAuth):
```python
import time
import cvat_sdk
from cvat_sdk.api import users_api
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
host = "http://localhost"
)
# 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 API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'
# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = users_api.UsersApi(api_client)
id = 1 # int | A unique integer value identifying this user.
x_organization = "X-Organization_example" # str | (optional)
org = "org_example" # str | Organization unique slug (optional)
org_id = 1 # int | Organization identifier (optional)
# example passing only required values which don't have defaults set
try:
# Method deletes a specific user from the server
api_instance.users_destroy(id)
except cvat_sdk.ApiException as e:
print("Exception when calling UsersApi->users_destroy: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Method deletes a specific user from the server
api_instance.users_destroy(id, x_organization=x_organization, org=org, org_id=org_id)
except cvat_sdk.ApiException as e:
print("Exception when calling UsersApi->users_destroy: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| A unique integer value identifying this user. |
**x_organization** | **str**| | [optional]
**org** | **str**| Organization unique slug | [optional]
**org_id** | **int**| Organization identifier | [optional]
### Return type
void (empty response body)
### Authorization
[SignatureAuthentication](../README.md#SignatureAuthentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | The user has been deleted | - |
[[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)
# **users_list**
> PaginatedMetaUserList users_list()
Method provides a paginated list of users registered on the server
### Example
* Api Key Authentication (SignatureAuthentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
* Api Key Authentication (tokenAuth):
```python
import time
import cvat_sdk
from cvat_sdk.api import users_api
from cvat_sdk.model.paginated_meta_user_list import PaginatedMetaUserList
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
host = "http://localhost"
)
# 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 API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'
# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = users_api.UsersApi(api_client)
x_organization = "X-Organization_example" # str | (optional)
filter = "filter_example" # str | A filter term. Avaliable filter_fields: ('id', 'is_active', 'username') (optional)
org = "org_example" # str | Organization unique slug (optional)
org_id = 1 # int | Organization identifier (optional)
page = 1 # int | A page number within the paginated result set. (optional)
page_size = 1 # int | Number of results to return per page. (optional)
search = "search_example" # str | A search term. Avaliable search_fields: ('username', 'first_name', 'last_name') (optional)
sort = "sort_example" # str | Which field to use when ordering the results. Avaliable ordering_fields: ('id', 'is_active', 'username') (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
# Method provides a paginated list of users registered on the server
api_response = api_instance.users_list(x_organization=x_organization, filter=filter, org=org, org_id=org_id, page=page, page_size=page_size, search=search, sort=sort)
pprint(api_response)
except cvat_sdk.ApiException as e:
print("Exception when calling UsersApi->users_list: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**x_organization** | **str**| | [optional]
**filter** | **str**| A filter term. Avaliable filter_fields: ('id', 'is_active', 'username') | [optional]
**org** | **str**| Organization unique slug | [optional]
**org_id** | **int**| Organization identifier | [optional]
**page** | **int**| A page number within the paginated result set. | [optional]
**page_size** | **int**| Number of results to return per page. | [optional]
**search** | **str**| A search term. Avaliable search_fields: ('username', 'first_name', 'last_name') | [optional]
**sort** | **str**| Which field to use when ordering the results. Avaliable ordering_fields: ('id', 'is_active', 'username') | [optional]
### Return type
[**PaginatedMetaUserList**](PaginatedMetaUserList.md)
### Authorization
[SignatureAuthentication](../README.md#SignatureAuthentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/vnd.cvat+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[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)
# **users_partial_update**
> MetaUser users_partial_update(id)
Method updates chosen fields of a user
### Example
* Api Key Authentication (SignatureAuthentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
* Api Key Authentication (tokenAuth):
```python
import time
import cvat_sdk
from cvat_sdk.api import users_api
from cvat_sdk.model.meta_user import MetaUser
from cvat_sdk.model.patched_user_request import PatchedUserRequest
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
host = "http://localhost"
)
# 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 API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'
# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = users_api.UsersApi(api_client)
id = 1 # int | A unique integer value identifying this user.
x_organization = "X-Organization_example" # str | (optional)
org = "org_example" # str | Organization unique slug (optional)
org_id = 1 # int | Organization identifier (optional)
patched_user_request = PatchedUserRequest(
username="A",
first_name="first_name_example",
last_name="last_name_example",
email="email_example",
groups=[
"groups_example",
],
is_staff=True,
is_superuser=True,
is_active=True,
) # PatchedUserRequest | (optional)
# example passing only required values which don't have defaults set
try:
# Method updates chosen fields of a user
api_response = api_instance.users_partial_update(id)
pprint(api_response)
except cvat_sdk.ApiException as e:
print("Exception when calling UsersApi->users_partial_update: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Method updates chosen fields of a user
api_response = api_instance.users_partial_update(id, x_organization=x_organization, org=org, org_id=org_id, patched_user_request=patched_user_request)
pprint(api_response)
except cvat_sdk.ApiException as e:
print("Exception when calling UsersApi->users_partial_update: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| A unique integer value identifying this user. |
**x_organization** | **str**| | [optional]
**org** | **str**| Organization unique slug | [optional]
**org_id** | **int**| Organization identifier | [optional]
**patched_user_request** | [**PatchedUserRequest**](PatchedUserRequest.md)| | [optional]
### Return type
[**MetaUser**](MetaUser.md)
### Authorization
[SignatureAuthentication](../README.md#SignatureAuthentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data, application/offset+octet-stream
- **Accept**: application/vnd.cvat+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[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)
# **users_retrieve**
> MetaUser users_retrieve(id)
Method provides information of a specific user
### Example
* Api Key Authentication (SignatureAuthentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
* Api Key Authentication (tokenAuth):
```python
import time
import cvat_sdk
from cvat_sdk.api import users_api
from cvat_sdk.model.meta_user import MetaUser
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
host = "http://localhost"
)
# 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 API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'
# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = users_api.UsersApi(api_client)
id = 1 # int | A unique integer value identifying this user.
x_organization = "X-Organization_example" # str | (optional)
org = "org_example" # str | Organization unique slug (optional)
org_id = 1 # int | Organization identifier (optional)
# example passing only required values which don't have defaults set
try:
# Method provides information of a specific user
api_response = api_instance.users_retrieve(id)
pprint(api_response)
except cvat_sdk.ApiException as e:
print("Exception when calling UsersApi->users_retrieve: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Method provides information of a specific user
api_response = api_instance.users_retrieve(id, x_organization=x_organization, org=org, org_id=org_id)
pprint(api_response)
except cvat_sdk.ApiException as e:
print("Exception when calling UsersApi->users_retrieve: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| A unique integer value identifying this user. |
**x_organization** | **str**| | [optional]
**org** | **str**| Organization unique slug | [optional]
**org_id** | **int**| Organization identifier | [optional]
### Return type
[**MetaUser**](MetaUser.md)
### Authorization
[SignatureAuthentication](../README.md#SignatureAuthentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/vnd.cvat+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[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)
# **users_retrieve_self**
> MetaUser users_retrieve_self()
Method returns an instance of a user who is currently authorized
Method returns an instance of a user who is currently authorized
### Example
* Api Key Authentication (SignatureAuthentication):
* Basic Authentication (basicAuth):
* Api Key Authentication (cookieAuth):
* Api Key Authentication (tokenAuth):
```python
import time
import cvat_sdk
from cvat_sdk.api import users_api
from cvat_sdk.model.meta_user import MetaUser
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
host = "http://localhost"
)
# 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 API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'
# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)
# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = users_api.UsersApi(api_client)
x_organization = "X-Organization_example" # str | (optional)
org = "org_example" # str | Organization unique slug (optional)
org_id = 1 # int | Organization identifier (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
# Method returns an instance of a user who is currently authorized
api_response = api_instance.users_retrieve_self(x_organization=x_organization, org=org, org_id=org_id)
pprint(api_response)
except cvat_sdk.ApiException as e:
print("Exception when calling UsersApi->users_retrieve_self: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**x_organization** | **str**| | [optional]
**org** | **str**| Organization unique slug | [optional]
**org_id** | **int**| Organization identifier | [optional]
### Return type
[**MetaUser**](MetaUser.md)
### Authorization
[SignatureAuthentication](../README.md#SignatureAuthentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/vnd.cvat+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[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)