ldap_authenticate#

Autogenerated API

argus_api.lib.authentication.v1.ldap.ldap_authenticate.ldap_authentication(requestedAuthorizations: str = None, userName: str = None, domain: str = None, password: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Initiate a new user session using LDAP authentication (PUBLIC)

Parameters

  • requestedAuthorizations (list) – Allow client to request authorizations as part of the authentication transaction. The client is not guaranteed to get the requested authorizations. The setPassword authorization is only returned if the current user has the FORCE_PW_CHANGE flag set.

  • userName (str) – Username to authenticate

  • domain (str) – User domain

  • password (str) – LDAP password for user

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.ldap.ldap_authenticate.ldap_user_authorization(operation: str = None, context: dict = None, nextURI: str = None, password: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Request an authorization token using LDAP credentials (INTERNAL)

Parameters

  • operation (str) – The name of the operation to authorize

  • context (dict) – Context variables to scope this authorization. All context variables required by the executing service must be present and equal to those provided here.

  • nextURI (str) – The URI to redirect/route to after successful authorization. The URI will be validated according to policy. The authorization token returned from successful authorization should be appended as a query parameter to this URI.

  • password (str) – The current users LDAP password

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.ldap.ldap_authenticate.legacy_l_d_a_p_authentication(requestedAuthorizations: str = None, userName: str = None, domain: str = None, password: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

DEPRECATED : legacy_l_d_a_p_authentication is an alias for legacy_ldap_authentication. Exists only for backward compatibility - do not use - use legacy_ldap_authentication instead.

argus_api.lib.authentication.v1.ldap.ldap_authenticate.legacy_ldap_authentication(requestedAuthorizations: str = None, userName: str = None, domain: str = None, password: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Initiate a new user session using LDAP authentication (PUBLIC)

Parameters

  • requestedAuthorizations (list) – Allow client to request authorizations as part of the authentication transaction. The client is not guaranteed to get the requested authorizations. The setPassword authorization is only returned if the current user has the FORCE_PW_CHANGE flag set.

  • userName (str) – Username to authenticate

  • domain (str) – User domain

  • password (str) – LDAP password for user

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON