4.6.7. Initial signup¶

API for performing initial signup.

class axonius_api_client.api.system.signup.Signup(url, **kwargs)[source]¶

Bases: object

API for performing initial signup.

Examples

Check if initial signup has been done: is_signed_up()
Perform initial signup: signup()

property is_signed_up: bool¶

Check if initial signup has been done.

Examples

>>> signup = axonius_api_client.Signup(url="10.20.0.61")
>>> signup.is_signed_up
True

Return type: bool

property system_status: axonius_api_client.api.json_api.signup.SystemStatus¶

Pass.

Return type: axonius_api_client.api.json_api.signup.SystemStatus

signup(password, company_name, contact_email)[source]¶

Perform the initial signup and get the API key and API secret of admin user.

Examples

>>> signup = axonius_api_client.Signup(url="10.20.0.61")
>>> data = signup.signup(
...     password="demo", company_name="Axonius", contact_email="jim@axonius.com"
... )
>>> data
{'api_key': 'xxxx', 'api_secret': 'xxxx'}

Parameters

password (str) – password for admin user
company_name (str) – name of company
contact_email (str) – email address of company contact

Return type

dict

validate_password_reset_token(token)[source]¶

Pass.

Parameters: token (str) –
Return type: bool

use_password_reset_token(token, password)[source]¶

Use a password token reset link to change a users password.

Parameters

token (str) – password reset token
password (str) – password to set

Notes

token can be generated by axonius_api_client.api.system.system_users.SystemUsers.get_password_reset_link() or axonius_api_client.api.system.system_users.SystemUsers.email_password_reset_link()

Return type: axonius_api_client.api.json_api.password_reset.UseResponse
Returns: name of user whose password was reset

_status()[source]¶

Direct API method to get the status of the overall system.

Return type: axonius_api_client.api.json_api.signup.SystemStatus

_get()[source]¶

Direct API method to get the status of initial signup.

Return type: axonius_api_client.api.json_api.generic.BoolValue

_token_validate(token)[source]¶

Pass.

Parameters: token (str) –
Return type: axonius_api_client.api.json_api.password_reset.ValidateResponse

_token_use(token, password)[source]¶

Direct API method to use a reset token to change a password.

Parameters

token (str) – password reset token
password (str) – password to set

Return type

axonius_api_client.api.json_api.password_reset.UseResponse

_perform(password, company_name, contact_email)[source]¶

Direct API method to do the initial signup.

Parameters

password (str) – password to set to admin user
company_name (str) – company name
contact_email (str) – contact email

Return type

axonius_api_client.api.json_api.signup.SignupResponse

__init__(url, **kwargs)[source]¶

Provide an API for performing initial signup.

Parameters

url – url of instance to perform signup against
**kwargs – passed thru to axonius_api_client.http.Http