lib/platform_rest/me.rb in losant_rest-1.19.1 vs lib/platform_rest/me.rb in losant_rest-1.19.2
- old
+ new
@@ -206,20 +206,20 @@
query: query_params,
headers: headers,
body: body)
end
- # Disables two factor auth for the current user
+ # Disables multi-factor authentication for the current user
#
# Authentication:
# The client must be configured with a valid api
# access token to call this action. The token
# must include at least one of the following scopes:
# all.User, me.*, or me.disableTwoFactorAuth.
#
# Parameters:
- # * {hash} data - Object containing two factor auth properties (https://api.losant.com/#/definitions/disableTwoFactorAuth)
+ # * {hash} data - Object containing multi-factor authentication properties (https://api.losant.com/#/definitions/multiFactorAuthDisable)
# * {string} losantdomain - Domain scope of request (rarely needed)
# * {boolean} _actions - Return resource actions in response
# * {boolean} _links - Return resource link in response
# * {boolean} _embedded - Return embedded resources in response
#
@@ -291,20 +291,20 @@
query: query_params,
headers: headers,
body: body)
end
- # Enables two factor auth for the current user
+ # Enables multi-factor authentication for the current user
#
# Authentication:
# The client must be configured with a valid api
# access token to call this action. The token
# must include at least one of the following scopes:
# all.User, me.*, or me.enableTwoFactorAuth.
#
# Parameters:
- # * {hash} data - Object containing two factor auth properties (https://api.losant.com/#/definitions/enableTwoFactorAuth)
+ # * {hash} data - Object containing multi-factor authentication properties (https://api.losant.com/#/definitions/multiFactorAuthEnable)
# * {string} losantdomain - Domain scope of request (rarely needed)
# * {boolean} _actions - Return resource actions in response
# * {boolean} _links - Return resource link in response
# * {boolean} _embedded - Return embedded resources in response
#
@@ -381,11 +381,11 @@
query: query_params,
headers: headers,
body: body)
end
- # Returns the two factor auth key for a user
+ # Returns the multi-factor authentication key for the current user
#
# Authentication:
# The client must be configured with a valid api
# access token to call this action. The token
# must include at least one of the following scopes:
@@ -396,10 +396,10 @@
# * {boolean} _actions - Return resource actions in response
# * {boolean} _links - Return resource link in response
# * {boolean} _embedded - Return embedded resources in response
#
# Responses:
- # * 200 - Updated user information (https://api.losant.com/#/definitions/twoFactorAuthInfo)
+ # * 200 - Multi-factor authentication info (https://api.losant.com/#/definitions/multiFactorAuthInfo)
#
# Errors:
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
def generate_two_factor_auth(params = {})
params = Utils.symbolize_hash_keys(params)