Python 3: User - Devolens (formerly Cryptolens) Documentation

Python 3 package licensing 0.54. Reviewed source revision.

from licensing.methods import User

These methods manage the usernames used by your software’s customers. Returned license lists are dictionaries; activate the selected license when your licensing model calls for activation. Retrieve the licenses associated with a customer’s username and password.

User.login(token, username, password)

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`username`	Required	The customer’s chosen username.
`password`	Required	The customer’s password.

Result

Returns (license_keys, ''), where license_keys is the API’s list of dictionaries. Returns (None, message) for API rejection or a handled request failure. Malformed response data can raise an exception.

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

register

User.register(token, username, password, email='', customerId=0)

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`username`	Required	The customer’s chosen username.
`password`	Required	The customer’s password.
`email`	`''`	The customer’s or user’s email address.
`customerId`	`0`	The numeric customer ID to associate with the new user.

Result

Returns (response_dict, ''). Returns (None, message) for API rejection or a handled request failure. Malformed response data can raise an exception.

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

associate

Associate a user with a customer ID.

User.associate(token, username, customer_id=0)

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`username`	Required	The customer’s chosen username.
`customer_id`	`0`	The numeric customer ID; see the method reference for the meaning of `0`.

Result

Returns (response_dict, ''). Returns (None, message) for API rejection or a handled request failure. Malformed response data can raise an exception.

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

dissociate

Remove a user’s customer association.

User.dissociate(token, username)

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`username`	Required	The customer’s chosen username.

Result

Returns (response_dict, ''). Returns (None, message) for API rejection or a handled request failure. Malformed response data can raise an exception.

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

get_users

List users, optionally filtered by customer.

User.get_users(token, customer_id=0)

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`customer_id`	`0`	The numeric customer ID; see the method reference for the meaning of `0`.

Result

Returns (users, ''), where users is a list of dictionaries. Returns (None, message) for API rejection or a handled request failure. Malformed response data can raise an exception.

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

change_password

Change a user’s password through the selected API workflow.

User.change_password(
    token,
    username,
    new_password,
    old_password='',
    password_reset_token='',
    admin_mode=False
)

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`username`	Required	The customer’s chosen username.
`new_password`	Required	The replacement password.
`old_password`	`''`	The current password when using the password-change workflow.
`password_reset_token`	`''`	The reset credential from `User.reset_password_token`.
`admin_mode`	`False`	Whether to use the API’s administrative password-change workflow.

Result

Returns (response_dict, ''). Returns (None, message) for API rejection or a handled request failure. Malformed response data can raise an exception.

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

reset_password_token

Request a password-reset credential for a user.

User.reset_password_token(token, username)

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`username`	Required	The customer’s chosen username.

Result

Returns (reset_credential, ''), containing the API’s passwordResetToken field. Returns (None, message) for API rejection or a handled request failure. Malformed response data can raise an exception.

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference.

remove_user

Remove a user.

User.remove_user(token, username)

Parameters

Parameter	Default	Meaning
`token`	Required	Your access token. It needs the permission required by the linked Web API method.
`username`	Required	The customer’s chosen username.

Result

Returns (response_dict, ''). Returns (None, message) for API rejection or a handled request failure. Malformed response data can raise an exception.

Checks

The API checks the access token’s permissions. This method does not verify a signed license response. Web API reference. Python SDK Reference

​login

​Parameters

​Result

​Checks

​register

​Parameters

​Result

​Checks

​associate

​Parameters

​Result

​Checks

​dissociate

​Parameters

​Result

​Checks

​get_users

​Parameters

​Result

​Checks

​change_password

​Parameters

​Result

​Checks

​reset_password_token

​Parameters

​Result

​Checks

​remove_user

​Parameters

​Result

​Checks

login

Parameters

Result

Checks

register

Parameters

Result

Checks

associate

Parameters

Result

Checks

dissociate

Parameters

Result

Checks

get_users

Parameters

Result

Checks

change_password

Parameters

Result

Checks

reset_password_token

Parameters

Result

Checks

remove_user

Parameters

Result

Checks