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
¶ 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
-
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'}
-
use_password_reset_token
(token, password)[source]¶ Use a password token reset link to change a users password.
Notes
token can be generated by
axonius_api_client.api.system.system_users.SystemUsers.get_password_reset_link()
oraxonius_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
-
_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
-
_perform
(password, company_name, contact_email)[source]¶ Direct API method to do the initial signup.
-
__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