api.authentication.v1.password package¶
Submodules¶
api.authentication.v1.password.password_authenticate module¶
Autogenerated API
-
api.authentication.v1.password.password_authenticate.
authenticate
(userName: str = None, domain: str = None, password: str = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]¶ Initiate a new user session using Password authentication (PUBLIC) Requires password authentication to be enabled on the server, and for the userUse /methods to check which authentication methods are available on the server. :rtype:
dict
:type authentication:dict
:type apiKey:str
:type verify:bool
:type json:bool
:type password:str
:type domain:str
:type userName:str
param str userName: Username to authenticate param str domain: User domain param str password: Static Argus-password for user raises AuthenticationFailedException: on 401 raises ValidationErrorException: on 412 raises AccessDeniedException: on 403 raises NotFoundException: on 404 returns: {‘offset’: 589, ‘limit’: 137, ‘responseCode’: 200, ‘count’: 210, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Contain know run real friend poor.’, ‘messageTemplate’: ‘Scientist look manage.’, ‘field’: ‘Miss walk phone politics mouth.’, ‘parameter’: {}, ‘timestamp’: 171885487}], ‘currentPage’: 516, ‘size’: 298}