user_api module#

class edgeimpulse_api.api.user_api.UserApi(api_client=None)[source]#

Bases: object

accept_terms_of_service(

**kwargs,

) → GenericApiResponse[source]#

Accept Terms of Service

Accept Terms of Service.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

activate_current_user(

activate_user_or_verify_email_request: ActivateUserOrVerifyEmailRequest,

**kwargs,

) → GenericApiResponse[source]#

Activate current user

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

Parameters:

activate_user_or_verify_email_request (ActivateUserOrVerifyEmailRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

activate_user(

user_id: StrictInt[StrictInt],

activate_user_or_verify_email_request: ActivateUserOrVerifyEmailRequest,

**kwargs,

) → GenericApiResponse[source]#

Activate user

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

Parameters:

user_id (int) – User ID (required)
activate_user_or_verify_email_request (ActivateUserOrVerifyEmailRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

activate_user_by_third_party_activation_code(

activate_user_by_third_party_activation_code_request: ActivateUserByThirdPartyActivationCodeRequest,

**kwargs,

) → GetJWTResponse[source]#

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:

activate_user_by_third_party_activation_code_request (ActivateUserByThirdPartyActivationCodeRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetJWTResponse

change_password_current_user(

change_password_request: ChangePasswordRequest,

**kwargs,

) → GenericApiResponse[source]#

Change password current user

Change the password for the current user account. This function is only available through a JWT token.

Parameters:

change_password_request (ChangePasswordRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

change_password_user(

user_id: StrictInt[StrictInt],

change_password_request: ChangePasswordRequest,

**kwargs,

) → GenericApiResponse[source]#

Change password

Change the password for a user account. This function is only available through a JWT token.

Parameters:

user_id (int) – User ID (required)
change_password_request (ChangePasswordRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

convert_current_user(

convert_user_request: ConvertUserRequest,

**kwargs,

) → GenericApiResponse[source]#

Convert current evaluation user

Convert current evaluation user account to regular account.

Parameters:

convert_user_request (ConvertUserRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

create_developer_profile(

**kwargs,

) → CreateDeveloperProfileResponse[source]#

Create developer profile

Create a developer profile for the current active user.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

CreateDeveloperProfileResponse

create_enterprise_trial_user(

create_enterprise_trial_user_request: CreateEnterpriseTrialUserRequest[CreateEnterpriseTrialUserRequest],

**kwargs,

) → CreateEnterpriseTrialResponse[source]#

Create enterprise trial user

Creates an enterprise trial user and a new trial organization, and redirects the user to the new organization.

Parameters:

create_enterprise_trial_user_request (CreateEnterpriseTrialUserRequest) – Trial request (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

CreateEnterpriseTrialResponse

create_evaluation_user(

**kwargs,

) → CreateEvaluationUserResponse[source]#

Create evaluation user

Creates an evaluation user and a new project, and redirects the user to the new project.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

CreateEvaluationUserResponse

create_user(

create_user_request: CreateUserRequest,

**kwargs,

) → CreateUserResponse[source]#

Create user

Create a new user and project

Parameters:

create_user_request (CreateUserRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

CreateUserResponse

delete_current_user(

**kwargs,

) → GenericApiResponse[source]#

Delete current user

Delete a user. This function is only available through a JWT token, and can only remove the current user.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

delete_photo_current_user(

**kwargs,

) → GenericApiResponse[source]#

Delete photo

Delete user profile photo. This function is only available through a JWT token.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

delete_user(

user_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Delete user

Delete a user. This function is only available through a JWT token, and can only remove the current user.

Parameters:

user_id (int) – User ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

get_current_user(

**kwargs,

) → GetUserResponse[source]#

Get current user

Get information about the current user. This function is only available through a JWT token.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetUserResponse

get_user(

user_id: StrictInt[StrictInt],

**kwargs,

) → GetUserResponse[source]#

Get user

Get information about a user. This function is only available through a JWT token.

Parameters:

user_id (int) – User ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetUserResponse

get_user_by_third_party_activation_code(

user_by_third_party_activation_request: UserByThirdPartyActivationRequest,

**kwargs,

) → GetUserResponse[source]#

Get user by third party activation code

Get information about a user through an activation code. This function is only available through a JWT token.

Parameters:

user_by_third_party_activation_request (UserByThirdPartyActivationRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetUserResponse

get_user_need_to_set_password(

username_or_email: StrictStr[StrictStr],

**kwargs,

) → GetUserNeedToSetPasswordResponse[source]#

Get user registration state

Tells whether a user is registered and whether it needs to set its password.

Parameters:

username_or_email (str) – Username or email (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetUserNeedToSetPasswordResponse

list_emails_current_user(

**kwargs,

) → ListEmailResponse[source]#

List emails

Get a list of all emails sent by Edge Impulse to the current user. This function is only available through a JWT token, and is not available for all users.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ListEmailResponse

list_emails_user(

user_id: StrictInt[StrictInt],

**kwargs,

) → ListEmailResponse[source]#

List emails

Get a list of all emails sent by Edge Impulse to a user. This function is only available through a JWT token, and is not available for all users.

Parameters:

user_id (int) – User ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ListEmailResponse

list_enterprise_trials_user(

user_id: StrictInt[StrictInt],

**kwargs,

) → ListEnterpriseTrialsResponse[source]#

Get enterprise trials

Get a list of all enterprise trials for a user. This function is only available through a JWT token.

Parameters:

user_id (int) – User ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ListEnterpriseTrialsResponse

list_organization_buckets_current_user(

**kwargs,

) → ListOrganizationBucketsUserResponse[source]#

Get buckets current user

List all organizational storage buckets that the current user has access to. This function is only available through a JWT token.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ListOrganizationBucketsUserResponse

list_organization_buckets_user(

user_id: StrictInt[StrictInt],

**kwargs,

) → ListOrganizationBucketsUserResponse[source]#

Get buckets

List all organizational storage buckets that a user has access to. This function is only available through a JWT token.

Parameters:

user_id (int) – User ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ListOrganizationBucketsUserResponse

list_organizations_current_user(

**kwargs,

) → ListOrganizationsResponse[source]#

Get organizations

List all organizations that the current user is a member of. This function is only available through a JWT token.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ListOrganizationsResponse

list_organizations_user(

user_id: StrictInt[StrictInt],

**kwargs,

) → ListOrganizationsResponse[source]#

Get organizations

List all organizations for a user. This function is only available through a JWT token.

Parameters:

user_id (int) – User ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ListOrganizationsResponse

request_activation_code_current_user(

**kwargs,

) → GenericApiResponse[source]#

Request activation code

Request a new activation code for the current user. This function is only available through a JWT token.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

request_activation_code_user(

user_id: StrictInt[StrictInt],

**kwargs,

) → GenericApiResponse[source]#

Request activation code

Request a new activation code. This function is only available through a JWT token.

Parameters:

user_id (int) – User ID (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

request_reset_password(

request_reset_password_request: RequestResetPasswordRequest,

**kwargs,

) → GenericApiResponse[source]#

Request reset password

Request a password reset link for a user.

Parameters:

request_reset_password_request (RequestResetPasswordRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

reset_password(

reset_password_request: ResetPasswordRequest,

**kwargs,

) → GenericApiResponse[source]#

Reset password

Reset the password for a user.

Parameters:

reset_password_request (ResetPasswordRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

send_user_feedback(

user_id: StrictInt[StrictInt],

send_user_feedback_request: SendUserFeedbackRequest,

**kwargs,

) → GenericApiResponse[source]#

Send feedback

Send feedback to Edge Impulse or get in touch with sales.

Parameters:

user_id (int) – User ID (required)
send_user_feedback_request (SendUserFeedbackRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

send_user_upgrade_request(

user_id: StrictInt[StrictInt],

enterprise_upgrade_or_trial_extension_request: EnterpriseUpgradeOrTrialExtensionRequest,

**kwargs,

) → GenericApiResponse[source]#

Send upgrade request

Send an upgrade to Enterprise request to Edge Impulse.

Parameters:

user_id (int) – User ID (required)
enterprise_upgrade_or_trial_extension_request (EnterpriseUpgradeOrTrialExtensionRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

set_user_password(

user_id: StrictInt[StrictInt],

set_user_password_request: SetUserPasswordRequest,

**kwargs,

) → GenericApiResponse[source]#

Set password for SSO user

Set the password for a new SSO user. This function is only available through an SSO access token.

Parameters:

user_id (int) – User ID (required)
set_user_password_request (SetUserPasswordRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

start_enterprise_trial(

start_enterprise_trial_request: StartEnterpriseTrialRequest,

**kwargs,

) → CreateEnterpriseTrialResponse[source]#

Start enterprise trial

Create an enterprise trial for the current user. Users can only go through a trial once.

Parameters:

start_enterprise_trial_request (StartEnterpriseTrialRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

CreateEnterpriseTrialResponse

update_current_user(

update_user_request: UpdateUserRequest,

**kwargs,

) → GenericApiResponse[source]#

Update current user

Update user properties such as name. This function is only available through a JWT token.

Parameters:

update_user_request (UpdateUserRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

update_user(

user_id: StrictInt[StrictInt],

update_user_request: UpdateUserRequest,

**kwargs,

) → GenericApiResponse[source]#

Update user

Update user properties such as name. This function is only available through a JWT token.

Parameters:

user_id (int) – User ID (required)
update_user_request (UpdateUserRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

upload_photo_current_user(

photo: StrictStr,

**kwargs,

) → UploadUserPhotoResponse[source]#

Upload photo

Upload a photo for the current user. This function is only available through a JWT token.

Parameters:

photo (str) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

UploadUserPhotoResponse

upload_photo_user(

user_id: StrictInt[StrictInt],

photo: StrictStr,

**kwargs,

) → UploadUserPhotoResponse[source]#

Upload photo

Upload a photo for a user. This function is only available through a JWT token, and is not available for all users.

Parameters:

user_id (int) – User ID (required)
photo (str) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

UploadUserPhotoResponse

user_delete_totp_mfa_key(

user_delete_totp_mfa_key_request: UserDeleteTotpMfaKeyRequest,

**kwargs,

) → GenericApiResponse[source]#

Remove TOTP MFA key

Disable MFA on this account using an TOTP token.

Parameters:

user_delete_totp_mfa_key_request (UserDeleteTotpMfaKeyRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

user_dismiss_notification(

user_dismiss_notification_request: UserDismissNotificationRequest,

**kwargs,

) → GenericApiResponse[source]#

Dismiss a notification

Parameters:

user_dismiss_notification_request (UserDismissNotificationRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

user_generate_new_totp_mfa_key(

**kwargs,

) → UserGenerateNewMfaKeyResponse[source]#

Generate a new TOTP MFA key

Creates a new MFA key, only allowed if the user has no MFA configured. TOTP tokens use SHA-1 algorithm.

Parameters:

async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

UserGenerateNewMfaKeyResponse

user_set_totp_mfa_key(

user_set_totp_mfa_key_request: UserSetTotpMfaKeyRequest,

**kwargs,

) → UserSetTotpMfaKeyResponse[source]#

Set TOTP MFA key

Enable MFA on this account using an TOTP token. First create a new key via userGenerateNewTotpMfaKey.

Parameters:

user_set_totp_mfa_key_request (UserSetTotpMfaKeyRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

UserSetTotpMfaKeyResponse

verify_reset_password(

verify_reset_password_request: VerifyResetPasswordRequest,

**kwargs,

) → GenericApiResponse[source]#

Verify reset password code

Verify whether the reset password code for the user is valid.

Parameters:

verify_reset_password_request (VerifyResetPasswordRequest) – (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse