sms_authenticate#

Autogenerated API

argus_api.lib.authentication.v1.sms.sms_authenticate.legacy_s_m_s_authentication(requestedAuthorizations: str = None, userName: str = None, domain: str = None, mode: str = None, passcode: str = None, cookie: 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_s_m_s_authentication is an alias for legacy_sms_authentication. Exists only for backward compatibility - do not use - use legacy_sms_authentication instead.

argus_api.lib.authentication.v1.sms.sms_authenticate.legacy_sms_authentication(requestedAuthorizations: str = None, userName: str = None, domain: str = None, mode: str = None, passcode: str = None, cookie: 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 SMS 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

  • mode (str) – Use PASSWORD for initial request, and SMS to respond with SMS code

  • passcode (str) – Password or SMS code

  • cookie (str) – When responding with SMS code, set the SMS session cookie returned by challenge

  • 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.sms.sms_authenticate.send_s_m_s_validation_code(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 : send_s_m_s_validation_code is an alias for send_sms_validation_code. Exists only for backward compatibility - do not use - use send_sms_validation_code instead.

argus_api.lib.authentication.v1.sms.sms_authenticate.send_sms_validation_code(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 SMS validation token to validate user presence. The returned token must be used when requesting authorization token. (INTERNAL)

Parameters

  • 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.sms.sms_authenticate.sms_authentication(requestedAuthorizations: str = None, userName: str = None, domain: str = None, mode: str = None, passcode: str = None, cookie: 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 SMS 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

  • mode (str) – Use PASSWORD for initial request, and SMS to respond with SMS code

  • passcode (str) – Password or SMS code

  • cookie (str) – When responding with SMS code, set the SMS session cookie returned by challenge

  • 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.sms.sms_authenticate.sms_user_authorization(operation: str = None, context: dict = None, nextURI: str = None, token: str = None, cookie: 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 an SMS validation code (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.

  • token (str) – The token received via SMS

  • cookie (str) – The cookie returned from the send-sms request

  • 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