user_api module

UserApi

class edgeimpulse_api.api.user_api.UserApi(
		api_client=None
)

Parameters

  • api_client=None

Methods

accept_terms_of_service

edgeimpulse_api.api.user_api.accept_terms_of_service(
		self,
		**kwargs
)> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Accept Terms of Service

Accept Terms of Service.

Parameters

  • self

  • **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

activate_current_user

edgeimpulse_api.api.user_api.activate_current_user(
		self,
		activate_user_or_verify_email_request: edgeimpulse_api.models.activate_user_or_verify_email_request.ActivateUserOrVerifyEmailRequest,
		**kwargs
)> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Activate current user

Activate the current user account (requires an activation code). This function is only available through a JWT token.

Parameters

  • self

  • activate_user_or_verify_email_request: edgeimpulse_api.models.activate_user_or_verify_email_request.ActivateUserOrVerifyEmailRequest

  • **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

activate_user

edgeimpulse_api.api.user_api.activate_user(
		self,
		user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})],
		activate_user_or_verify_email_request: edgeimpulse_api.models.activate_user_or_verify_email_request.ActivateUserOrVerifyEmailRequest,
		**kwargs
)> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Activate user

Activate a user account (requires an activation code). This function is only available through a JWT token.

Parameters

  • self

  • user_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='User ID', extra={})]

  • activate_user_or_verify_email_request: edgeimpulse_api.models.activate_user_or_verify_email_request.ActivateUserOrVerifyEmailRequest

  • **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

activate_user_by_third_party_activation_code

edgeimpulse_api.api.user_api.activate_user_by_third_party_activation_code(
		self,
		activate_user_by_third_party_activation_code_request: edgeimpulse_api.models.activate_user_by_third_party_activation_code_request.ActivateUserByThirdPartyActivationCodeRequest,
		**kwargs
)> edgeimpulse_api.models.get_jwt_response.GetJWTResponse

Activate user by third party activation code

Activate a user that was created by a third party. This function is only available through a JWT token.

Parameters

  • self

  • activate_user_by_third_party_activation_code_request: edgeimpulse_api.models.activate_user_by_third_party_activation_code_request.ActivateUserByThirdPartyActivationCodeRequest