api.authentication.v1.ldap package

Submodules

api.authentication.v1.ldap.ldap_authenticate module

Autogenerated API

api.authentication.v1.ldap.ldap_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 LDAP authentication (PUBLIC) Requires ldap 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:
 LDAP password for user
raises AuthenticationFailedException:
 on 401
raises ValidationErrorException:
 on 412
returns:{‘offset’: 382, ‘limit’: 749, ‘responseCode’: 200, ‘count’: 37, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Population sea tree big wear skin.’, ‘messageTemplate’: ‘Friend one someone short development success.’, ‘field’: ‘Day society history building foreign material man pay.’, ‘parameter’: {}, ‘timestamp’: 295071459}], ‘currentPage’: 481, ‘size’: 66}

Module contents