login_radius 11.0.0 → 11.2.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (29) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE.txt +21 -21
  3. data/README.md +58 -58
  4. data/lib/login_radius/api/account/account_api.rb +581 -581
  5. data/lib/login_radius/api/account/role_api.rb +330 -330
  6. data/lib/login_radius/api/account/sott_api.rb +47 -47
  7. data/lib/login_radius/api/advanced/configuration_api.rb +57 -57
  8. data/lib/login_radius/api/advanced/consent_management_api.rb +161 -161
  9. data/lib/login_radius/api/advanced/custom_object_api.rb +316 -316
  10. data/lib/login_radius/api/advanced/custom_registration_data_api.rb +195 -195
  11. data/lib/login_radius/api/advanced/multi_factor_authentication_api.rb +942 -606
  12. data/lib/login_radius/api/advanced/re_authentication_api.rb +317 -243
  13. data/lib/login_radius/api/advanced/web_hook_api.rb +101 -101
  14. data/lib/login_radius/api/authentication/authentication_api.rb +1036 -989
  15. data/lib/login_radius/api/authentication/one_touch_login_api.rb +160 -160
  16. data/lib/login_radius/api/authentication/password_less_login_api.rb +202 -158
  17. data/lib/login_radius/api/authentication/phone_authentication_api.rb +329 -329
  18. data/lib/login_radius/api/authentication/pin_authentication_api.rb +316 -316
  19. data/lib/login_radius/api/authentication/risk_based_authentication_api.rb +286 -286
  20. data/lib/login_radius/api/authentication/smart_login_api.rb +146 -146
  21. data/lib/login_radius/api/social/native_social_api.rb +255 -255
  22. data/lib/login_radius/api/social/social_api.rb +784 -806
  23. data/lib/login_radius/error.rb +7 -7
  24. data/lib/login_radius/request_client.rb +311 -295
  25. data/lib/login_radius/response.rb +18 -12
  26. data/lib/login_radius/version.rb +2 -2
  27. data/lib/login_radius.rb +30 -30
  28. data/login_radius.gemspec +25 -28
  29. metadata +7 -7
@@ -1,286 +1,286 @@
1
- # frozen_string_literal: true
2
-
3
- # Created by LoginRadius Development Team
4
- # Copyright 2019 LoginRadius Inc. All rights reserved.
5
- require_relative '../../request_client'
6
-
7
- module LoginRadius
8
- # RiskBasedAuthenticationApi module
9
- class RiskBasedAuthenticationApi
10
- include RequestClient
11
-
12
- attr_accessor :site_name, :api_key, :api_secret
13
-
14
- # Initializes a LoginRadius Account object with an apikey and secret
15
- # Takes in a hash containing site_name(required), api_key(required), api_secret(required)
16
- def initialize
17
- @site_name = ENV['SITE_NAME']
18
- @api_key = ENV['API_KEY']
19
- @api_secret = ENV['API_SECRET']
20
- raise LoginRadius::Error.new, "'site_name' is a required option for Account class initialization." \
21
- unless @site_name != '' && @site_name != nil
22
- raise LoginRadius::Error.new, "'api_key' is a required option for Account class initialization." \
23
- unless @api_key != '' && @api_key != nil
24
- raise LoginRadius::Error.new, "'api_secret is a required option for Account class initialization." \
25
- unless @api_secret != '' && @api_secret != nil
26
- end
27
-
28
- # This API retrieves a copy of the user data based on the Email
29
- #
30
- # @param email_authentication_model - Model Class containing Definition of payload for Email Authentication API
31
- # @param email_template - Email template name
32
- # @param fields - The fields parameter filters the API response so that the response only includes a specific set of fields
33
- # @param login_url - Url where the user is logging from
34
- # @param password_delegation - Password Delegation Allows you to use a third-party service to store your passwords rather than LoginRadius Cloud storage.
35
- # @param password_delegation_app - RiskBased Authentication Password Delegation App
36
- # @param rba_browser_email_template - Risk Based Authentication Browser EmailTemplate
37
- # @param rba_browser_sms_template - Risk Based Authentication Browser Sms Template
38
- # @param rba_city_email_template - Risk Based Authentication City Email Template
39
- # @param rba_city_sms_template - Risk Based Authentication City SmsTemplate
40
- # @param rba_country_email_template - Risk Based Authentication Country EmailTemplate
41
- # @param rba_country_sms_template - Risk Based Authentication Country SmsTemplate
42
- # @param rba_ip_email_template - Risk Based Authentication Ip EmailTemplate
43
- # @param rba_ip_sms_template - Risk Based Authentication Ip SmsTemplate
44
- # @param rba_oneclick_email_template - Risk Based Authentication Oneclick EmailTemplate
45
- # @param rba_otp_sms_template - Risk Based Authentication Oneclick EmailTemplate
46
- # @param sms_template - SMS Template name
47
- # @param verification_url - Email verification url
48
- #
49
- # @return Response containing User Profile Data and access token
50
- # 9.2.4
51
- def rba_login_by_email(email_authentication_model, email_template = '', fields = '', login_url = '', password_delegation = false, password_delegation_app = '', rba_browser_email_template = '', rba_browser_sms_template = '', rba_city_email_template = '', rba_city_sms_template = '', rba_country_email_template = '', rba_country_sms_template = '', rba_ip_email_template = '', rba_ip_sms_template = '', rba_oneclick_email_template = '', rba_otp_sms_template = '', sms_template = '', verification_url = '')
52
- if email_authentication_model.blank?
53
- raise LoginRadius::Error.new, getValidationMessage('email_authentication_model')
54
- end
55
-
56
- query_parameters = {}
57
- query_parameters['apiKey'] = @api_key
58
- unless isNullOrWhiteSpace(email_template)
59
- query_parameters['emailTemplate'] = email_template
60
- end
61
- unless isNullOrWhiteSpace(fields)
62
- query_parameters['fields'] = fields
63
- end
64
- unless isNullOrWhiteSpace(login_url)
65
- query_parameters['loginUrl'] = login_url
66
- end
67
- unless password_delegation == false
68
- query_parameters['passwordDelegation'] = password_delegation
69
- end
70
- unless isNullOrWhiteSpace(password_delegation_app)
71
- query_parameters['passwordDelegationApp'] = password_delegation_app
72
- end
73
- unless isNullOrWhiteSpace(rba_browser_email_template)
74
- query_parameters['rbaBrowserEmailTemplate'] = rba_browser_email_template
75
- end
76
- unless isNullOrWhiteSpace(rba_browser_sms_template)
77
- query_parameters['rbaBrowserSmsTemplate'] = rba_browser_sms_template
78
- end
79
- unless isNullOrWhiteSpace(rba_city_email_template)
80
- query_parameters['rbaCityEmailTemplate'] = rba_city_email_template
81
- end
82
- unless isNullOrWhiteSpace(rba_city_sms_template)
83
- query_parameters['rbaCitySmsTemplate'] = rba_city_sms_template
84
- end
85
- unless isNullOrWhiteSpace(rba_country_email_template)
86
- query_parameters['rbaCountryEmailTemplate'] = rba_country_email_template
87
- end
88
- unless isNullOrWhiteSpace(rba_country_sms_template)
89
- query_parameters['rbaCountrySmsTemplate'] = rba_country_sms_template
90
- end
91
- unless isNullOrWhiteSpace(rba_ip_email_template)
92
- query_parameters['rbaIpEmailTemplate'] = rba_ip_email_template
93
- end
94
- unless isNullOrWhiteSpace(rba_ip_sms_template)
95
- query_parameters['rbaIpSmsTemplate'] = rba_ip_sms_template
96
- end
97
- unless isNullOrWhiteSpace(rba_oneclick_email_template)
98
- query_parameters['rbaOneclickEmailTemplate'] = rba_oneclick_email_template
99
- end
100
- unless isNullOrWhiteSpace(rba_otp_sms_template)
101
- query_parameters['rbaOTPSmsTemplate'] = rba_otp_sms_template
102
- end
103
- unless isNullOrWhiteSpace(sms_template)
104
- query_parameters['smsTemplate'] = sms_template
105
- end
106
- unless isNullOrWhiteSpace(verification_url)
107
- query_parameters['verificationUrl'] = verification_url
108
- end
109
-
110
- resource_path = 'identity/v2/auth/login'
111
- post_request(resource_path, query_parameters, email_authentication_model)
112
- end
113
-
114
- # This API retrieves a copy of the user data based on the Username
115
- #
116
- # @param user_name_authentication_model - Model Class containing Definition of payload for Username Authentication API
117
- # @param email_template - Email template name
118
- # @param fields - The fields parameter filters the API response so that the response only includes a specific set of fields
119
- # @param login_url - Url where the user is logging from
120
- # @param password_delegation - Password Delegation Allows you to use a third-party service to store your passwords rather than LoginRadius Cloud storage.
121
- # @param password_delegation_app - RiskBased Authentication Password Delegation App
122
- # @param rba_browser_email_template - Risk Based Authentication Browser EmailTemplate
123
- # @param rba_browser_sms_template - Risk Based Authentication Browser Sms Template
124
- # @param rba_city_email_template - Risk Based Authentication City Email Template
125
- # @param rba_city_sms_template - Risk Based Authentication City SmsTemplate
126
- # @param rba_country_email_template - Risk Based Authentication Country EmailTemplate
127
- # @param rba_country_sms_template - Risk Based Authentication Country SmsTemplate
128
- # @param rba_ip_email_template - Risk Based Authentication Ip EmailTemplate
129
- # @param rba_ip_sms_template - Risk Based Authentication Ip SmsTemplate
130
- # @param rba_oneclick_email_template - Risk Based Authentication Oneclick EmailTemplate
131
- # @param rba_otp_sms_template - Risk Based Authentication OTPSmsTemplate
132
- # @param sms_template - SMS Template name
133
- # @param verification_url - Email verification url
134
- #
135
- # @return Response containing User Profile Data and access token
136
- # 9.2.5
137
- def rba_login_by_user_name(user_name_authentication_model, email_template = '', fields = '', login_url = '', password_delegation = false, password_delegation_app = '', rba_browser_email_template = '', rba_browser_sms_template = '', rba_city_email_template = '', rba_city_sms_template = '', rba_country_email_template = '', rba_country_sms_template = '', rba_ip_email_template = '', rba_ip_sms_template = '', rba_oneclick_email_template = '', rba_otp_sms_template = '', sms_template = '', verification_url = '')
138
- if user_name_authentication_model.blank?
139
- raise LoginRadius::Error.new, getValidationMessage('user_name_authentication_model')
140
- end
141
-
142
- query_parameters = {}
143
- query_parameters['apiKey'] = @api_key
144
- unless isNullOrWhiteSpace(email_template)
145
- query_parameters['emailTemplate'] = email_template
146
- end
147
- unless isNullOrWhiteSpace(fields)
148
- query_parameters['fields'] = fields
149
- end
150
- unless isNullOrWhiteSpace(login_url)
151
- query_parameters['loginUrl'] = login_url
152
- end
153
- unless password_delegation == false
154
- query_parameters['passwordDelegation'] = password_delegation
155
- end
156
- unless isNullOrWhiteSpace(password_delegation_app)
157
- query_parameters['passwordDelegationApp'] = password_delegation_app
158
- end
159
- unless isNullOrWhiteSpace(rba_browser_email_template)
160
- query_parameters['rbaBrowserEmailTemplate'] = rba_browser_email_template
161
- end
162
- unless isNullOrWhiteSpace(rba_browser_sms_template)
163
- query_parameters['rbaBrowserSmsTemplate'] = rba_browser_sms_template
164
- end
165
- unless isNullOrWhiteSpace(rba_city_email_template)
166
- query_parameters['rbaCityEmailTemplate'] = rba_city_email_template
167
- end
168
- unless isNullOrWhiteSpace(rba_city_sms_template)
169
- query_parameters['rbaCitySmsTemplate'] = rba_city_sms_template
170
- end
171
- unless isNullOrWhiteSpace(rba_country_email_template)
172
- query_parameters['rbaCountryEmailTemplate'] = rba_country_email_template
173
- end
174
- unless isNullOrWhiteSpace(rba_country_sms_template)
175
- query_parameters['rbaCountrySmsTemplate'] = rba_country_sms_template
176
- end
177
- unless isNullOrWhiteSpace(rba_ip_email_template)
178
- query_parameters['rbaIpEmailTemplate'] = rba_ip_email_template
179
- end
180
- unless isNullOrWhiteSpace(rba_ip_sms_template)
181
- query_parameters['rbaIpSmsTemplate'] = rba_ip_sms_template
182
- end
183
- unless isNullOrWhiteSpace(rba_oneclick_email_template)
184
- query_parameters['rbaOneclickEmailTemplate'] = rba_oneclick_email_template
185
- end
186
- unless isNullOrWhiteSpace(rba_otp_sms_template)
187
- query_parameters['rbaOTPSmsTemplate'] = rba_otp_sms_template
188
- end
189
- unless isNullOrWhiteSpace(sms_template)
190
- query_parameters['smsTemplate'] = sms_template
191
- end
192
- unless isNullOrWhiteSpace(verification_url)
193
- query_parameters['verificationUrl'] = verification_url
194
- end
195
-
196
- resource_path = 'identity/v2/auth/login'
197
- post_request(resource_path, query_parameters, user_name_authentication_model)
198
- end
199
-
200
- # This API retrieves a copy of the user data based on the Phone
201
- #
202
- # @param phone_authentication_model - Model Class containing Definition of payload for PhoneAuthenticationModel API
203
- # @param email_template - Email template name
204
- # @param fields - The fields parameter filters the API response so that the response only includes a specific set of fields
205
- # @param login_url - Url where the user is logging from
206
- # @param password_delegation - Password Delegation Allows you to use a third-party service to store your passwords rather than LoginRadius Cloud storage.
207
- # @param password_delegation_app - RiskBased Authentication Password Delegation App
208
- # @param rba_browser_email_template - Risk Based Authentication Browser EmailTemplate
209
- # @param rba_browser_sms_template - Risk Based Authentication Browser Sms Template
210
- # @param rba_city_email_template - Risk Based Authentication City Email Template
211
- # @param rba_city_sms_template - Risk Based Authentication City SmsTemplate
212
- # @param rba_country_email_template - Risk Based Authentication Country EmailTemplate
213
- # @param rba_country_sms_template - Risk Based Authentication Country SmsTemplate
214
- # @param rba_ip_email_template - Risk Based Authentication Ip EmailTemplate
215
- # @param rba_ip_sms_template - Risk Based Authentication Ip SmsTemplate
216
- # @param rba_oneclick_email_template - Risk Based Authentication Oneclick EmailTemplate
217
- # @param rba_otp_sms_template - Risk Based Authentication OTPSmsTemplate
218
- # @param sms_template - SMS Template name
219
- # @param verification_url - Email verification url
220
- #
221
- # @return Response containing User Profile Data and access token
222
- # 9.2.6
223
- def rba_login_by_phone(phone_authentication_model, email_template = '', fields = '', login_url = '', password_delegation = false, password_delegation_app = '', rba_browser_email_template = '', rba_browser_sms_template = '', rba_city_email_template = '', rba_city_sms_template = '', rba_country_email_template = '', rba_country_sms_template = '', rba_ip_email_template = '', rba_ip_sms_template = '', rba_oneclick_email_template = '', rba_otp_sms_template = '', sms_template = '', verification_url = '')
224
- if phone_authentication_model.blank?
225
- raise LoginRadius::Error.new, getValidationMessage('phone_authentication_model')
226
- end
227
-
228
- query_parameters = {}
229
- query_parameters['apiKey'] = @api_key
230
- unless isNullOrWhiteSpace(email_template)
231
- query_parameters['emailTemplate'] = email_template
232
- end
233
- unless isNullOrWhiteSpace(fields)
234
- query_parameters['fields'] = fields
235
- end
236
- unless isNullOrWhiteSpace(login_url)
237
- query_parameters['loginUrl'] = login_url
238
- end
239
- unless password_delegation == false
240
- query_parameters['passwordDelegation'] = password_delegation
241
- end
242
- unless isNullOrWhiteSpace(password_delegation_app)
243
- query_parameters['passwordDelegationApp'] = password_delegation_app
244
- end
245
- unless isNullOrWhiteSpace(rba_browser_email_template)
246
- query_parameters['rbaBrowserEmailTemplate'] = rba_browser_email_template
247
- end
248
- unless isNullOrWhiteSpace(rba_browser_sms_template)
249
- query_parameters['rbaBrowserSmsTemplate'] = rba_browser_sms_template
250
- end
251
- unless isNullOrWhiteSpace(rba_city_email_template)
252
- query_parameters['rbaCityEmailTemplate'] = rba_city_email_template
253
- end
254
- unless isNullOrWhiteSpace(rba_city_sms_template)
255
- query_parameters['rbaCitySmsTemplate'] = rba_city_sms_template
256
- end
257
- unless isNullOrWhiteSpace(rba_country_email_template)
258
- query_parameters['rbaCountryEmailTemplate'] = rba_country_email_template
259
- end
260
- unless isNullOrWhiteSpace(rba_country_sms_template)
261
- query_parameters['rbaCountrySmsTemplate'] = rba_country_sms_template
262
- end
263
- unless isNullOrWhiteSpace(rba_ip_email_template)
264
- query_parameters['rbaIpEmailTemplate'] = rba_ip_email_template
265
- end
266
- unless isNullOrWhiteSpace(rba_ip_sms_template)
267
- query_parameters['rbaIpSmsTemplate'] = rba_ip_sms_template
268
- end
269
- unless isNullOrWhiteSpace(rba_oneclick_email_template)
270
- query_parameters['rbaOneclickEmailTemplate'] = rba_oneclick_email_template
271
- end
272
- unless isNullOrWhiteSpace(rba_otp_sms_template)
273
- query_parameters['rbaOTPSmsTemplate'] = rba_otp_sms_template
274
- end
275
- unless isNullOrWhiteSpace(sms_template)
276
- query_parameters['smsTemplate'] = sms_template
277
- end
278
- unless isNullOrWhiteSpace(verification_url)
279
- query_parameters['verificationUrl'] = verification_url
280
- end
281
-
282
- resource_path = 'identity/v2/auth/login'
283
- post_request(resource_path, query_parameters, phone_authentication_model)
284
- end
285
- end
286
- end
1
+ # frozen_string_literal: true
2
+
3
+ # Created by LoginRadius Development Team
4
+ # Copyright 2019 LoginRadius Inc. All rights reserved.
5
+ require_relative '../../request_client'
6
+
7
+ module LoginRadius
8
+ # RiskBasedAuthenticationApi module
9
+ class RiskBasedAuthenticationApi
10
+ include RequestClient
11
+
12
+ attr_accessor :site_name, :api_key, :api_secret
13
+
14
+ # Initializes a LoginRadius Account object with an apikey and secret
15
+ # Takes in a hash containing site_name(required), api_key(required), api_secret(required)
16
+ def initialize
17
+ @site_name = ENV['SITE_NAME']
18
+ @api_key = ENV['API_KEY']
19
+ @api_secret = ENV['API_SECRET']
20
+ raise LoginRadius::Error.new, "'site_name' is a required option for Account class initialization." \
21
+ unless @site_name != '' && @site_name != nil
22
+ raise LoginRadius::Error.new, "'api_key' is a required option for Account class initialization." \
23
+ unless @api_key != '' && @api_key != nil
24
+ raise LoginRadius::Error.new, "'api_secret is a required option for Account class initialization." \
25
+ unless @api_secret != '' && @api_secret != nil
26
+ end
27
+
28
+ # This API retrieves a copy of the user data based on the Email
29
+ #
30
+ # @param email_authentication_model - Model Class containing Definition of payload for Email Authentication API
31
+ # @param email_template - Email template name
32
+ # @param fields - The fields parameter filters the API response so that the response only includes a specific set of fields
33
+ # @param login_url - Url where the user is logging from
34
+ # @param password_delegation - Password Delegation Allows you to use a third-party service to store your passwords rather than LoginRadius Cloud storage.
35
+ # @param password_delegation_app - RiskBased Authentication Password Delegation App
36
+ # @param rba_browser_email_template - Risk Based Authentication Browser EmailTemplate
37
+ # @param rba_browser_sms_template - Risk Based Authentication Browser Sms Template
38
+ # @param rba_city_email_template - Risk Based Authentication City Email Template
39
+ # @param rba_city_sms_template - Risk Based Authentication City SmsTemplate
40
+ # @param rba_country_email_template - Risk Based Authentication Country EmailTemplate
41
+ # @param rba_country_sms_template - Risk Based Authentication Country SmsTemplate
42
+ # @param rba_ip_email_template - Risk Based Authentication Ip EmailTemplate
43
+ # @param rba_ip_sms_template - Risk Based Authentication Ip SmsTemplate
44
+ # @param rba_oneclick_email_template - Risk Based Authentication Oneclick EmailTemplate
45
+ # @param rba_otp_sms_template - Risk Based Authentication Oneclick EmailTemplate
46
+ # @param sms_template - SMS Template name
47
+ # @param verification_url - Email verification url
48
+ #
49
+ # @return Response containing User Profile Data and access token
50
+ # 9.2.4
51
+ def rba_login_by_email(email_authentication_model, email_template = '', fields = '', login_url = '', password_delegation = false, password_delegation_app = '', rba_browser_email_template = '', rba_browser_sms_template = '', rba_city_email_template = '', rba_city_sms_template = '', rba_country_email_template = '', rba_country_sms_template = '', rba_ip_email_template = '', rba_ip_sms_template = '', rba_oneclick_email_template = '', rba_otp_sms_template = '', sms_template = '', verification_url = '')
52
+ if email_authentication_model.blank?
53
+ raise LoginRadius::Error.new, getValidationMessage('email_authentication_model')
54
+ end
55
+
56
+ query_parameters = {}
57
+ query_parameters['apiKey'] = @api_key
58
+ unless isNullOrWhiteSpace(email_template)
59
+ query_parameters['emailTemplate'] = email_template
60
+ end
61
+ unless isNullOrWhiteSpace(fields)
62
+ query_parameters['fields'] = fields
63
+ end
64
+ unless isNullOrWhiteSpace(login_url)
65
+ query_parameters['loginUrl'] = login_url
66
+ end
67
+ unless password_delegation == false
68
+ query_parameters['passwordDelegation'] = password_delegation
69
+ end
70
+ unless isNullOrWhiteSpace(password_delegation_app)
71
+ query_parameters['passwordDelegationApp'] = password_delegation_app
72
+ end
73
+ unless isNullOrWhiteSpace(rba_browser_email_template)
74
+ query_parameters['rbaBrowserEmailTemplate'] = rba_browser_email_template
75
+ end
76
+ unless isNullOrWhiteSpace(rba_browser_sms_template)
77
+ query_parameters['rbaBrowserSmsTemplate'] = rba_browser_sms_template
78
+ end
79
+ unless isNullOrWhiteSpace(rba_city_email_template)
80
+ query_parameters['rbaCityEmailTemplate'] = rba_city_email_template
81
+ end
82
+ unless isNullOrWhiteSpace(rba_city_sms_template)
83
+ query_parameters['rbaCitySmsTemplate'] = rba_city_sms_template
84
+ end
85
+ unless isNullOrWhiteSpace(rba_country_email_template)
86
+ query_parameters['rbaCountryEmailTemplate'] = rba_country_email_template
87
+ end
88
+ unless isNullOrWhiteSpace(rba_country_sms_template)
89
+ query_parameters['rbaCountrySmsTemplate'] = rba_country_sms_template
90
+ end
91
+ unless isNullOrWhiteSpace(rba_ip_email_template)
92
+ query_parameters['rbaIpEmailTemplate'] = rba_ip_email_template
93
+ end
94
+ unless isNullOrWhiteSpace(rba_ip_sms_template)
95
+ query_parameters['rbaIpSmsTemplate'] = rba_ip_sms_template
96
+ end
97
+ unless isNullOrWhiteSpace(rba_oneclick_email_template)
98
+ query_parameters['rbaOneclickEmailTemplate'] = rba_oneclick_email_template
99
+ end
100
+ unless isNullOrWhiteSpace(rba_otp_sms_template)
101
+ query_parameters['rbaOTPSmsTemplate'] = rba_otp_sms_template
102
+ end
103
+ unless isNullOrWhiteSpace(sms_template)
104
+ query_parameters['smsTemplate'] = sms_template
105
+ end
106
+ unless isNullOrWhiteSpace(verification_url)
107
+ query_parameters['verificationUrl'] = verification_url
108
+ end
109
+
110
+ resource_path = 'identity/v2/auth/login'
111
+ post_request(resource_path, query_parameters, email_authentication_model)
112
+ end
113
+
114
+ # This API retrieves a copy of the user data based on the Username
115
+ #
116
+ # @param user_name_authentication_model - Model Class containing Definition of payload for Username Authentication API
117
+ # @param email_template - Email template name
118
+ # @param fields - The fields parameter filters the API response so that the response only includes a specific set of fields
119
+ # @param login_url - Url where the user is logging from
120
+ # @param password_delegation - Password Delegation Allows you to use a third-party service to store your passwords rather than LoginRadius Cloud storage.
121
+ # @param password_delegation_app - RiskBased Authentication Password Delegation App
122
+ # @param rba_browser_email_template - Risk Based Authentication Browser EmailTemplate
123
+ # @param rba_browser_sms_template - Risk Based Authentication Browser Sms Template
124
+ # @param rba_city_email_template - Risk Based Authentication City Email Template
125
+ # @param rba_city_sms_template - Risk Based Authentication City SmsTemplate
126
+ # @param rba_country_email_template - Risk Based Authentication Country EmailTemplate
127
+ # @param rba_country_sms_template - Risk Based Authentication Country SmsTemplate
128
+ # @param rba_ip_email_template - Risk Based Authentication Ip EmailTemplate
129
+ # @param rba_ip_sms_template - Risk Based Authentication Ip SmsTemplate
130
+ # @param rba_oneclick_email_template - Risk Based Authentication Oneclick EmailTemplate
131
+ # @param rba_otp_sms_template - Risk Based Authentication OTPSmsTemplate
132
+ # @param sms_template - SMS Template name
133
+ # @param verification_url - Email verification url
134
+ #
135
+ # @return Response containing User Profile Data and access token
136
+ # 9.2.5
137
+ def rba_login_by_user_name(user_name_authentication_model, email_template = '', fields = '', login_url = '', password_delegation = false, password_delegation_app = '', rba_browser_email_template = '', rba_browser_sms_template = '', rba_city_email_template = '', rba_city_sms_template = '', rba_country_email_template = '', rba_country_sms_template = '', rba_ip_email_template = '', rba_ip_sms_template = '', rba_oneclick_email_template = '', rba_otp_sms_template = '', sms_template = '', verification_url = '')
138
+ if user_name_authentication_model.blank?
139
+ raise LoginRadius::Error.new, getValidationMessage('user_name_authentication_model')
140
+ end
141
+
142
+ query_parameters = {}
143
+ query_parameters['apiKey'] = @api_key
144
+ unless isNullOrWhiteSpace(email_template)
145
+ query_parameters['emailTemplate'] = email_template
146
+ end
147
+ unless isNullOrWhiteSpace(fields)
148
+ query_parameters['fields'] = fields
149
+ end
150
+ unless isNullOrWhiteSpace(login_url)
151
+ query_parameters['loginUrl'] = login_url
152
+ end
153
+ unless password_delegation == false
154
+ query_parameters['passwordDelegation'] = password_delegation
155
+ end
156
+ unless isNullOrWhiteSpace(password_delegation_app)
157
+ query_parameters['passwordDelegationApp'] = password_delegation_app
158
+ end
159
+ unless isNullOrWhiteSpace(rba_browser_email_template)
160
+ query_parameters['rbaBrowserEmailTemplate'] = rba_browser_email_template
161
+ end
162
+ unless isNullOrWhiteSpace(rba_browser_sms_template)
163
+ query_parameters['rbaBrowserSmsTemplate'] = rba_browser_sms_template
164
+ end
165
+ unless isNullOrWhiteSpace(rba_city_email_template)
166
+ query_parameters['rbaCityEmailTemplate'] = rba_city_email_template
167
+ end
168
+ unless isNullOrWhiteSpace(rba_city_sms_template)
169
+ query_parameters['rbaCitySmsTemplate'] = rba_city_sms_template
170
+ end
171
+ unless isNullOrWhiteSpace(rba_country_email_template)
172
+ query_parameters['rbaCountryEmailTemplate'] = rba_country_email_template
173
+ end
174
+ unless isNullOrWhiteSpace(rba_country_sms_template)
175
+ query_parameters['rbaCountrySmsTemplate'] = rba_country_sms_template
176
+ end
177
+ unless isNullOrWhiteSpace(rba_ip_email_template)
178
+ query_parameters['rbaIpEmailTemplate'] = rba_ip_email_template
179
+ end
180
+ unless isNullOrWhiteSpace(rba_ip_sms_template)
181
+ query_parameters['rbaIpSmsTemplate'] = rba_ip_sms_template
182
+ end
183
+ unless isNullOrWhiteSpace(rba_oneclick_email_template)
184
+ query_parameters['rbaOneclickEmailTemplate'] = rba_oneclick_email_template
185
+ end
186
+ unless isNullOrWhiteSpace(rba_otp_sms_template)
187
+ query_parameters['rbaOTPSmsTemplate'] = rba_otp_sms_template
188
+ end
189
+ unless isNullOrWhiteSpace(sms_template)
190
+ query_parameters['smsTemplate'] = sms_template
191
+ end
192
+ unless isNullOrWhiteSpace(verification_url)
193
+ query_parameters['verificationUrl'] = verification_url
194
+ end
195
+
196
+ resource_path = 'identity/v2/auth/login'
197
+ post_request(resource_path, query_parameters, user_name_authentication_model)
198
+ end
199
+
200
+ # This API retrieves a copy of the user data based on the Phone
201
+ #
202
+ # @param phone_authentication_model - Model Class containing Definition of payload for PhoneAuthenticationModel API
203
+ # @param email_template - Email template name
204
+ # @param fields - The fields parameter filters the API response so that the response only includes a specific set of fields
205
+ # @param login_url - Url where the user is logging from
206
+ # @param password_delegation - Password Delegation Allows you to use a third-party service to store your passwords rather than LoginRadius Cloud storage.
207
+ # @param password_delegation_app - RiskBased Authentication Password Delegation App
208
+ # @param rba_browser_email_template - Risk Based Authentication Browser EmailTemplate
209
+ # @param rba_browser_sms_template - Risk Based Authentication Browser Sms Template
210
+ # @param rba_city_email_template - Risk Based Authentication City Email Template
211
+ # @param rba_city_sms_template - Risk Based Authentication City SmsTemplate
212
+ # @param rba_country_email_template - Risk Based Authentication Country EmailTemplate
213
+ # @param rba_country_sms_template - Risk Based Authentication Country SmsTemplate
214
+ # @param rba_ip_email_template - Risk Based Authentication Ip EmailTemplate
215
+ # @param rba_ip_sms_template - Risk Based Authentication Ip SmsTemplate
216
+ # @param rba_oneclick_email_template - Risk Based Authentication Oneclick EmailTemplate
217
+ # @param rba_otp_sms_template - Risk Based Authentication OTPSmsTemplate
218
+ # @param sms_template - SMS Template name
219
+ # @param verification_url - Email verification url
220
+ #
221
+ # @return Response containing User Profile Data and access token
222
+ # 9.2.6
223
+ def rba_login_by_phone(phone_authentication_model, email_template = '', fields = '', login_url = '', password_delegation = false, password_delegation_app = '', rba_browser_email_template = '', rba_browser_sms_template = '', rba_city_email_template = '', rba_city_sms_template = '', rba_country_email_template = '', rba_country_sms_template = '', rba_ip_email_template = '', rba_ip_sms_template = '', rba_oneclick_email_template = '', rba_otp_sms_template = '', sms_template = '', verification_url = '')
224
+ if phone_authentication_model.blank?
225
+ raise LoginRadius::Error.new, getValidationMessage('phone_authentication_model')
226
+ end
227
+
228
+ query_parameters = {}
229
+ query_parameters['apiKey'] = @api_key
230
+ unless isNullOrWhiteSpace(email_template)
231
+ query_parameters['emailTemplate'] = email_template
232
+ end
233
+ unless isNullOrWhiteSpace(fields)
234
+ query_parameters['fields'] = fields
235
+ end
236
+ unless isNullOrWhiteSpace(login_url)
237
+ query_parameters['loginUrl'] = login_url
238
+ end
239
+ unless password_delegation == false
240
+ query_parameters['passwordDelegation'] = password_delegation
241
+ end
242
+ unless isNullOrWhiteSpace(password_delegation_app)
243
+ query_parameters['passwordDelegationApp'] = password_delegation_app
244
+ end
245
+ unless isNullOrWhiteSpace(rba_browser_email_template)
246
+ query_parameters['rbaBrowserEmailTemplate'] = rba_browser_email_template
247
+ end
248
+ unless isNullOrWhiteSpace(rba_browser_sms_template)
249
+ query_parameters['rbaBrowserSmsTemplate'] = rba_browser_sms_template
250
+ end
251
+ unless isNullOrWhiteSpace(rba_city_email_template)
252
+ query_parameters['rbaCityEmailTemplate'] = rba_city_email_template
253
+ end
254
+ unless isNullOrWhiteSpace(rba_city_sms_template)
255
+ query_parameters['rbaCitySmsTemplate'] = rba_city_sms_template
256
+ end
257
+ unless isNullOrWhiteSpace(rba_country_email_template)
258
+ query_parameters['rbaCountryEmailTemplate'] = rba_country_email_template
259
+ end
260
+ unless isNullOrWhiteSpace(rba_country_sms_template)
261
+ query_parameters['rbaCountrySmsTemplate'] = rba_country_sms_template
262
+ end
263
+ unless isNullOrWhiteSpace(rba_ip_email_template)
264
+ query_parameters['rbaIpEmailTemplate'] = rba_ip_email_template
265
+ end
266
+ unless isNullOrWhiteSpace(rba_ip_sms_template)
267
+ query_parameters['rbaIpSmsTemplate'] = rba_ip_sms_template
268
+ end
269
+ unless isNullOrWhiteSpace(rba_oneclick_email_template)
270
+ query_parameters['rbaOneclickEmailTemplate'] = rba_oneclick_email_template
271
+ end
272
+ unless isNullOrWhiteSpace(rba_otp_sms_template)
273
+ query_parameters['rbaOTPSmsTemplate'] = rba_otp_sms_template
274
+ end
275
+ unless isNullOrWhiteSpace(sms_template)
276
+ query_parameters['smsTemplate'] = sms_template
277
+ end
278
+ unless isNullOrWhiteSpace(verification_url)
279
+ query_parameters['verificationUrl'] = verification_url
280
+ end
281
+
282
+ resource_path = 'identity/v2/auth/login'
283
+ post_request(resource_path, query_parameters, phone_authentication_model)
284
+ end
285
+ end
286
+ end