Skip to content

Latest commit

 

History

History
189 lines (129 loc) · 6.17 KB

RegistrationSupportApi.md

File metadata and controls

189 lines (129 loc) · 6.17 KB

openapi_client.RegistrationSupportApi

All URIs are relative to /api/v2

Method HTTP request Description
register_user POST /support/users Register a user
update_user_verification PATCH /support/users Update user details

register_user

RegisterResponseSchema register_user(register_user_post_schema)

Register a user

Register a user with the given details

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (apiSecret):
import openapi_client
from openapi_client.models.register_response_schema import RegisterResponseSchema
from openapi_client.models.register_user_post_schema import RegisterUserPostSchema
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/api/v2"
)

# 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: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: apiSecret
configuration.api_key['apiSecret'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiSecret'] = 'Bearer'

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.RegistrationSupportApi(api_client)
    register_user_post_schema = openapi_client.RegisterUserPostSchema() # RegisterUserPostSchema | 

    try:
        # Register a user
        api_response = api_instance.register_user(register_user_post_schema)
        print("The response of RegistrationSupportApi->register_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RegistrationSupportApi->register_user: %s\n" % e)

Parameters

Name Type Description Notes
register_user_post_schema RegisterUserPostSchema

Return type

RegisterResponseSchema

Authorization

apiKey, apiSecret

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Document created, URL follows -
400 Bad Request -
200 Successful patch -
401 Authorization error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_user_verification

RegisterResponseSchema update_user_verification(register_user_patches)

Update user details

Update user details

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (apiSecret):
import openapi_client
from openapi_client.models.register_response_schema import RegisterResponseSchema
from openapi_client.models.register_user_patches import RegisterUserPatches
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/api/v2"
)

# 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: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: apiSecret
configuration.api_key['apiSecret'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiSecret'] = 'Bearer'

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.RegistrationSupportApi(api_client)
    register_user_patches = openapi_client.RegisterUserPatches() # RegisterUserPatches | 

    try:
        # Update user details
        api_response = api_instance.update_user_verification(register_user_patches)
        print("The response of RegistrationSupportApi->update_user_verification:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RegistrationSupportApi->update_user_verification: %s\n" % e)

Parameters

Name Type Description Notes
register_user_patches RegisterUserPatches

Return type

RegisterResponseSchema

Authorization

apiKey, apiSecret

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful patch -
400 Bad Request -
401 Authorization error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]