4.6.7. Initial signup¶

Warning

This API is deprecated.

Axonius API v2 is now available, we recommend you move to API v2.

New features will no longer be added to this API. Axonius will only provide bug fixes.

Read about API v2

API for performing initial signup.

class axonius_api_client.api.system.signup.Signup(auth, log_level='debug', **kwargs)[source]¶

Bases: ModelMixins

API for performing initial signup and other unauthenticated endpoints.

Examples

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

Parameters:

auth (axonius_api_client.auth.model.AuthModel) –
log_level (typing.Union[int, str]) –

property is_signed_up: bool¶

Check if initial signup has been done.

Examples

>>> import axonius_api_client as axonapi
>>> url: str = "10.0.3.2"
>>> client: axonapi.Connect = axonapi.Connect(url=url, key="", secret="")
>>> client.signup.is_signed_up
True

property system_status: SystemStatus¶: Pass.

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

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

Examples

>>> import axonius_api_client as axonapi
>>> url: str = "10.0.3.2"
>>> client: axonapi.Connect = axonapi.Connect(url=url, key="", secret="")
>>> data = client.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]¶

Validate that a password reset token is legit.

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

property is_expired: bool¶: Check if the system has expired.

property is_licensed: bool¶: Check if the system is licensed.

property indication_color: str¶: Get the indication color.

property login_options: dict¶: Get the login options.

_get_login_options()[source]¶

Direct API method to get the login options.

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

_get_indication_color()[source]¶

Direct API method to get the indication color.

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

_license_status()[source]¶

Direct API method to get the license status.

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

_expired()[source]¶

Direct API method to get the expiry status.

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

_status()[source]¶

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

Return type:: axonius_api_client.api.json_api.signup.system_status.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.signup_response.SignupResponse

LOG: logging.Logger = None¶: Logger for this object.

__init__(auth, log_level='debug', **kwargs)¶

Mixins for API Models.

Parameters:

auth (axonius_api_client.auth.model.AuthModel) – object to use for auth and sending API requests
log_level (typing.Union[int, str]) – logging level to use for this objects logger
**kwargs – passed to _init()

__repr__()¶

Show info for this model object.

Return type:: str

__str__()¶

Show info for this model object.

Return type:: str

_init(**kwargs)¶: Post init method for subclasses to use for extra setup.

_init_auth(**kwargs)¶: Post init method for subclasses to use for overriding auth setup.

auth: axonius_api_client.auth.model.AuthModel = None¶: Authentication model with bound Http object to use for requests.

http: axonius_api_client.http.Http = None¶: Http object to use for requests.