api.authentication.v1.radius package¶
Submodules¶
api.authentication.v1.radius.radius_authenticate module¶
Autogenerated API
-
api.authentication.v1.radius.radius_authenticate.
authenticate
(userName: str = None, domain: str = None, mode: str = None, password: str = None, tokenCode: str = None, state: str = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]¶ Initiate a new user session using RADIUS authentication (PUBLIC) Requires RADIUS authentication to be enabled on the server, and for the user. Use /methods to check which authentication methods are available on the server.
This is a 2-factor authentication method, which may require additional verification. The first request should have mode AUTHENTICATION, and carry username, password and tokencode. If the authentication is challenged, submit a new request with mode CHALLENGE, andinclude the state variable returned in the challenge. :rtype:
dict
:type authentication:dict
:type apiKey:str
:type verify:bool
:type json:bool
:type state:str
:type tokenCode:str
:type password:str
:type mode:str
:type domain:str
:type userName:str
param str userName: Username to authenticate param str domain: User domain param str mode: Authentication mode. Use AUTHENTICATION for normal authentication, or CHALLENGE to respond to a challenge request param str password: RADIUS static password param str tokenCode: RADIUS token code param str state: When responding to a challenge, include the encoded state returned by the challenge. raises AuthenticationFailedException: on 401 raises ValidationErrorException: on 412 raises AccessDeniedException: on 403 raises NotFoundException: on 404 returns: {‘offset’: 618, ‘limit’: 478, ‘responseCode’: 200, ‘count’: 193, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Authority report executive half their apply.’, ‘messageTemplate’: ‘Maybe move financial college family.’, ‘field’: ‘She offer family official value gun determine.’, ‘parameter’: {}, ‘timestamp’: 508212575}], ‘currentPage’: 537, ‘size’: 550}