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.
829 lines
31 KiB
Markdown
829 lines
31 KiB
Markdown
# cvat_sdk.AuthApi
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**auth_create_login**](AuthApi.md#auth_create_login) | **POST** /api/auth/login |
|
|
[**auth_create_logout**](AuthApi.md#auth_create_logout) | **POST** /api/auth/logout |
|
|
[**auth_create_password_change**](AuthApi.md#auth_create_password_change) | **POST** /api/auth/password/change |
|
|
[**auth_create_password_reset**](AuthApi.md#auth_create_password_reset) | **POST** /api/auth/password/reset |
|
|
[**auth_create_password_reset_confirm**](AuthApi.md#auth_create_password_reset_confirm) | **POST** /api/auth/password/reset/confirm |
|
|
[**auth_create_register**](AuthApi.md#auth_create_register) | **POST** /api/auth/register |
|
|
[**auth_create_signing**](AuthApi.md#auth_create_signing) | **POST** /api/auth/signing | This method signs URL for access to the server
|
|
|
|
|
|
# **auth_create_login**
|
|
> Token auth_create_login(login_request)
|
|
|
|
|
|
|
|
Check the credentials and return the REST Token if the credentials are valid and authenticated. Calls Django Auth login method to register User ID in Django session framework Accept the following POST parameters: username, password Return the REST Framework Token Object's key.
|
|
|
|
### 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 auth_api
|
|
from cvat_sdk.model.token import Token
|
|
from cvat_sdk.model.login_request import LoginRequest
|
|
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 = auth_api.AuthApi(api_client)
|
|
login_request = LoginRequest(
|
|
username="username_example",
|
|
email="email_example",
|
|
password="password_example",
|
|
) # LoginRequest |
|
|
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:
|
|
api_response = api_instance.auth_create_login(login_request)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling AuthApi->auth_create_login: %s\n" % e)
|
|
|
|
# example passing only required values which don't have defaults set
|
|
# and optional values
|
|
try:
|
|
api_response = api_instance.auth_create_login(login_request, x_organization=x_organization, org=org, org_id=org_id)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling AuthApi->auth_create_login: %s\n" % e)
|
|
```
|
|
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**login_request** | [**LoginRequest**](LoginRequest.md)| |
|
|
**x_organization** | **str**| | [optional]
|
|
**org** | **str**| Organization unique slug | [optional]
|
|
**org_id** | **int**| Organization identifier | [optional]
|
|
|
|
### Return type
|
|
|
|
[**Token**](Token.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)
|
|
|
|
# **auth_create_logout**
|
|
> RestAuthDetail auth_create_logout()
|
|
|
|
|
|
|
|
Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing.
|
|
|
|
### 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 auth_api
|
|
from cvat_sdk.model.rest_auth_detail import RestAuthDetail
|
|
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 = auth_api.AuthApi(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:
|
|
api_response = api_instance.auth_create_logout(x_organization=x_organization, org=org, org_id=org_id)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling AuthApi->auth_create_logout: %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
|
|
|
|
[**RestAuthDetail**](RestAuthDetail.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)
|
|
|
|
# **auth_create_password_change**
|
|
> RestAuthDetail auth_create_password_change(password_change_request)
|
|
|
|
|
|
|
|
Calls Django Auth SetPasswordForm save method. Accepts the following POST parameters: new_password1, new_password2 Returns the success/fail message.
|
|
|
|
### 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 auth_api
|
|
from cvat_sdk.model.password_change_request import PasswordChangeRequest
|
|
from cvat_sdk.model.rest_auth_detail import RestAuthDetail
|
|
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 = auth_api.AuthApi(api_client)
|
|
password_change_request = PasswordChangeRequest(
|
|
old_password="old_password_example",
|
|
new_password1="new_password1_example",
|
|
new_password2="new_password2_example",
|
|
) # PasswordChangeRequest |
|
|
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:
|
|
api_response = api_instance.auth_create_password_change(password_change_request)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling AuthApi->auth_create_password_change: %s\n" % e)
|
|
|
|
# example passing only required values which don't have defaults set
|
|
# and optional values
|
|
try:
|
|
api_response = api_instance.auth_create_password_change(password_change_request, x_organization=x_organization, org=org, org_id=org_id)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling AuthApi->auth_create_password_change: %s\n" % e)
|
|
```
|
|
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**password_change_request** | [**PasswordChangeRequest**](PasswordChangeRequest.md)| |
|
|
**x_organization** | **str**| | [optional]
|
|
**org** | **str**| Organization unique slug | [optional]
|
|
**org_id** | **int**| Organization identifier | [optional]
|
|
|
|
### Return type
|
|
|
|
[**RestAuthDetail**](RestAuthDetail.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)
|
|
|
|
# **auth_create_password_reset**
|
|
> RestAuthDetail auth_create_password_reset(password_reset_serializer_ex_request)
|
|
|
|
|
|
|
|
Calls Django Auth PasswordResetForm save method. Accepts the following POST parameters: email Returns the success/fail message.
|
|
|
|
### 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 auth_api
|
|
from cvat_sdk.model.password_reset_serializer_ex_request import PasswordResetSerializerExRequest
|
|
from cvat_sdk.model.rest_auth_detail import RestAuthDetail
|
|
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 = auth_api.AuthApi(api_client)
|
|
password_reset_serializer_ex_request = PasswordResetSerializerExRequest(
|
|
email="email_example",
|
|
) # PasswordResetSerializerExRequest |
|
|
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:
|
|
api_response = api_instance.auth_create_password_reset(password_reset_serializer_ex_request)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling AuthApi->auth_create_password_reset: %s\n" % e)
|
|
|
|
# example passing only required values which don't have defaults set
|
|
# and optional values
|
|
try:
|
|
api_response = api_instance.auth_create_password_reset(password_reset_serializer_ex_request, x_organization=x_organization, org=org, org_id=org_id)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling AuthApi->auth_create_password_reset: %s\n" % e)
|
|
```
|
|
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**password_reset_serializer_ex_request** | [**PasswordResetSerializerExRequest**](PasswordResetSerializerExRequest.md)| |
|
|
**x_organization** | **str**| | [optional]
|
|
**org** | **str**| Organization unique slug | [optional]
|
|
**org_id** | **int**| Organization identifier | [optional]
|
|
|
|
### Return type
|
|
|
|
[**RestAuthDetail**](RestAuthDetail.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)
|
|
|
|
# **auth_create_password_reset_confirm**
|
|
> RestAuthDetail auth_create_password_reset_confirm(password_reset_confirm_request)
|
|
|
|
|
|
|
|
Password reset e-mail link is confirmed, therefore this resets the user's password. Accepts the following POST parameters: token, uid, new_password1, new_password2 Returns the success/fail message.
|
|
|
|
### 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 auth_api
|
|
from cvat_sdk.model.password_reset_confirm_request import PasswordResetConfirmRequest
|
|
from cvat_sdk.model.rest_auth_detail import RestAuthDetail
|
|
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 = auth_api.AuthApi(api_client)
|
|
password_reset_confirm_request = PasswordResetConfirmRequest(
|
|
new_password1="new_password1_example",
|
|
new_password2="new_password2_example",
|
|
uid="uid_example",
|
|
token="token_example",
|
|
) # PasswordResetConfirmRequest |
|
|
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:
|
|
api_response = api_instance.auth_create_password_reset_confirm(password_reset_confirm_request)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling AuthApi->auth_create_password_reset_confirm: %s\n" % e)
|
|
|
|
# example passing only required values which don't have defaults set
|
|
# and optional values
|
|
try:
|
|
api_response = api_instance.auth_create_password_reset_confirm(password_reset_confirm_request, x_organization=x_organization, org=org, org_id=org_id)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling AuthApi->auth_create_password_reset_confirm: %s\n" % e)
|
|
```
|
|
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**password_reset_confirm_request** | [**PasswordResetConfirmRequest**](PasswordResetConfirmRequest.md)| |
|
|
**x_organization** | **str**| | [optional]
|
|
**org** | **str**| Organization unique slug | [optional]
|
|
**org_id** | **int**| Organization identifier | [optional]
|
|
|
|
### Return type
|
|
|
|
[**RestAuthDetail**](RestAuthDetail.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)
|
|
|
|
# **auth_create_register**
|
|
> RestrictedRegister auth_create_register(restricted_register_request)
|
|
|
|
|
|
|
|
### 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 auth_api
|
|
from cvat_sdk.model.restricted_register_request import RestrictedRegisterRequest
|
|
from cvat_sdk.model.restricted_register import RestrictedRegister
|
|
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 = auth_api.AuthApi(api_client)
|
|
restricted_register_request = RestrictedRegisterRequest(
|
|
username="username_example",
|
|
email="email_example",
|
|
password1="password1_example",
|
|
password2="password2_example",
|
|
first_name="first_name_example",
|
|
last_name="last_name_example",
|
|
confirmations=[
|
|
UserAgreementRequest(
|
|
name="name_example",
|
|
display_text="",
|
|
url="",
|
|
required=False,
|
|
value=False,
|
|
),
|
|
],
|
|
) # RestrictedRegisterRequest |
|
|
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:
|
|
api_response = api_instance.auth_create_register(restricted_register_request)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling AuthApi->auth_create_register: %s\n" % e)
|
|
|
|
# example passing only required values which don't have defaults set
|
|
# and optional values
|
|
try:
|
|
api_response = api_instance.auth_create_register(restricted_register_request, x_organization=x_organization, org=org, org_id=org_id)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling AuthApi->auth_create_register: %s\n" % e)
|
|
```
|
|
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**restricted_register_request** | [**RestrictedRegisterRequest**](RestrictedRegisterRequest.md)| |
|
|
**x_organization** | **str**| | [optional]
|
|
**org** | **str**| Organization unique slug | [optional]
|
|
**org_id** | **int**| Organization identifier | [optional]
|
|
|
|
### Return type
|
|
|
|
[**RestrictedRegister**](RestrictedRegister.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 |
|
|
|-------------|-------------|------------------|
|
|
**201** | | - |
|
|
|
|
[[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)
|
|
|
|
# **auth_create_signing**
|
|
> str auth_create_signing(signing_request)
|
|
|
|
This method signs URL for access to the server
|
|
|
|
Signed URL contains a token which authenticates a user on the server.Signed URL is valid during 30 seconds since signing.
|
|
|
|
### 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 auth_api
|
|
from cvat_sdk.model.signing_request import SigningRequest
|
|
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 = auth_api.AuthApi(api_client)
|
|
signing_request = SigningRequest(
|
|
url="url_example",
|
|
) # SigningRequest |
|
|
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:
|
|
# This method signs URL for access to the server
|
|
api_response = api_instance.auth_create_signing(signing_request)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling AuthApi->auth_create_signing: %s\n" % e)
|
|
|
|
# example passing only required values which don't have defaults set
|
|
# and optional values
|
|
try:
|
|
# This method signs URL for access to the server
|
|
api_response = api_instance.auth_create_signing(signing_request, x_organization=x_organization, org=org, org_id=org_id)
|
|
pprint(api_response)
|
|
except cvat_sdk.ApiException as e:
|
|
print("Exception when calling AuthApi->auth_create_signing: %s\n" % e)
|
|
```
|
|
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**signing_request** | [**SigningRequest**](SigningRequest.md)| |
|
|
**x_organization** | **str**| | [optional]
|
|
**org** | **str**| Organization unique slug | [optional]
|
|
**org_id** | **int**| Organization identifier | [optional]
|
|
|
|
### Return type
|
|
|
|
**str**
|
|
|
|
### 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** | text URL | - |
|
|
|
|
[[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)
|
|
|