auth0 3.1.2 → 3.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (54) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -1
  3. data/auth0.gemspec +6 -5
  4. data/lib/auth0/api/authentication_endpoints.rb +19 -2
  5. data/lib/auth0/mixins/initializer.rb +3 -3
  6. data/lib/auth0/version.rb +1 -1
  7. data/spec/lib/auth0/api/authentication_endpoints_spec.rb +20 -2
  8. data/spec/lib/auth0/client_spec.rb +1 -1
  9. data/spec/lib/auth0/mixins/initializer_spec.rb +28 -0
  10. metadata +44 -72
  11. data/doc/Auth0.html +0 -153
  12. data/doc/Auth0/AccessDenied.html +0 -142
  13. data/doc/Auth0/Api.html +0 -128
  14. data/doc/Auth0/Api/AuthenticationEndpoints.html +0 -592
  15. data/doc/Auth0/Api/V1.html +0 -188
  16. data/doc/Auth0/Api/V1/Clients.html +0 -440
  17. data/doc/Auth0/Api/V1/Connections.html +0 -506
  18. data/doc/Auth0/Api/V1/Logs.html +0 -366
  19. data/doc/Auth0/Api/V1/Rules.html +0 -439
  20. data/doc/Auth0/Api/V1/Users.html +0 -1617
  21. data/doc/Auth0/Api/V2.html +0 -193
  22. data/doc/Auth0/Api/V2/Blacklists.html +0 -268
  23. data/doc/Auth0/Api/V2/Clients.html +0 -477
  24. data/doc/Auth0/Api/V2/Jobs.html +0 -277
  25. data/doc/Auth0/Api/V2/Router.html +0 -109
  26. data/doc/Auth0/Api/V2/Stats.html +0 -268
  27. data/doc/Auth0/Api/V2/Users.html +0 -652
  28. data/doc/Auth0/BadRequest.html +0 -142
  29. data/doc/Auth0/Client.html +0 -164
  30. data/doc/Auth0/Exception.html +0 -140
  31. data/doc/Auth0/InvalidParameter.html +0 -142
  32. data/doc/Auth0/Mixins.html +0 -153
  33. data/doc/Auth0/Mixins/HTTPartyProxy.html +0 -121
  34. data/doc/Auth0/Mixins/Initializer.html +0 -312
  35. data/doc/Auth0/NotFound.html +0 -143
  36. data/doc/Auth0/ServerError.html +0 -142
  37. data/doc/Auth0/Unauthorized.html +0 -143
  38. data/doc/Auth0/Unsupported.html +0 -142
  39. data/doc/Auth0/UserIdIsBlank.html +0 -143
  40. data/doc/Auth0Client.html +0 -163
  41. data/doc/_index.html +0 -418
  42. data/doc/class_list.html +0 -58
  43. data/doc/css/common.css +0 -1
  44. data/doc/css/full_list.css +0 -57
  45. data/doc/css/style.css +0 -339
  46. data/doc/file.README.html +0 -103
  47. data/doc/file_list.html +0 -60
  48. data/doc/frames.html +0 -26
  49. data/doc/index.html +0 -103
  50. data/doc/js/app.js +0 -219
  51. data/doc/js/full_list.js +0 -181
  52. data/doc/js/jquery.js +0 -4
  53. data/doc/method_list.html +0 -435
  54. data/doc/top-level-namespace.html +0 -114
@@ -1,1617 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
- <head>
5
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
- <title>
7
- Module: Auth0::Api::V1::Users
8
-
9
- &mdash; Documentation by YARD 0.8.7.6
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
14
-
15
- <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
16
-
17
- <script type="text/javascript" charset="utf-8">
18
- hasFrames = window.top.frames.main ? true : false;
19
- relpath = '../../../';
20
- framesUrl = "../../../frames.html#!Auth0/Api/V1/Users.html";
21
- </script>
22
-
23
-
24
- <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
25
-
26
- <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
27
-
28
-
29
- </head>
30
- <body>
31
- <div id="header">
32
- <div id="menu">
33
-
34
- <a href="../../../_index.html">Index (U)</a> &raquo;
35
- <span class='title'><span class='object_link'><a href="../../../Auth0.html" title="Auth0 (module)">Auth0</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Api.html" title="Auth0::Api (module)">Api</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../V1.html" title="Auth0::Api::V1 (module)">V1</a></span></span>
36
- &raquo;
37
- <span class="title">Users</span>
38
-
39
-
40
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
- </div>
42
-
43
- <div id="search">
44
-
45
- <a class="full_list_link" id="class_list_link"
46
- href="../../../class_list.html">
47
- Class List
48
- </a>
49
-
50
- <a class="full_list_link" id="method_list_link"
51
- href="../../../method_list.html">
52
- Method List
53
- </a>
54
-
55
- <a class="full_list_link" id="file_list_link"
56
- href="../../../file_list.html">
57
- File List
58
- </a>
59
-
60
- </div>
61
- <div class="clear"></div>
62
- </div>
63
-
64
- <iframe id="search_frame"></iframe>
65
-
66
- <div id="content"><h1>Module: Auth0::Api::V1::Users
67
-
68
-
69
-
70
- </h1>
71
-
72
- <dl class="box">
73
-
74
-
75
-
76
-
77
-
78
-
79
-
80
- <dt class="r1">Included in:</dt>
81
- <dd class="r1"><span class='object_link'><a href="../V1.html" title="Auth0::Api::V1 (module)">Auth0::Api::V1</a></span></dd>
82
-
83
-
84
-
85
- <dt class="r2 last">Defined in:</dt>
86
- <dd class="r2 last">lib/auth0/api/v1/users.rb</dd>
87
-
88
- </dl>
89
- <div class="clear"></div>
90
-
91
- <h2>Overview</h2><div class="docstring">
92
- <div class="discussion">
93
-
94
- <p><a href="https://auth0.com/docs/api#users" target="_parent" title="https://auth0.com/docs/api#users">https://auth0.com/docs/api#users</a></p>
95
-
96
-
97
- </div>
98
- </div>
99
- <div class="tags">
100
-
101
-
102
- </div>
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
- <h2>
111
- Instance Method Summary
112
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
113
- </h2>
114
-
115
- <ul class="summary">
116
-
117
- <li class="public ">
118
- <span class="summary_signature">
119
-
120
- <a href="#change_password_ticket-instance_method" title="#change_password_ticket (instance method)">- (Object) <strong>change_password_ticket</strong>(user_id, new_password, result_url = nil) </a>
121
-
122
-
123
-
124
- </span>
125
-
126
-
127
-
128
-
129
-
130
-
131
-
132
-
133
-
134
- <span class="summary_desc"><div class='inline'>
135
- <p><a href="https://auth0.com/docs/api#!#post–api-users–user_id–change_password_ticket" target="_parent" title="https://auth0.com/docs/api#!#post–api-users–user_id–change_password_ticket">https://auth0.com/docs/api#!#post–api-users–user_id–change_password_ticket</a>.</p>
136
- </div></span>
137
-
138
- </li>
139
-
140
-
141
- <li class="public ">
142
- <span class="summary_signature">
143
-
144
- <a href="#client_users-instance_method" title="#client_users (instance method)">- (Object) <strong>client_users</strong>(client_id = @client_id) </a>
145
-
146
-
147
-
148
- </span>
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
-
158
- <span class="summary_desc"><div class='inline'>
159
- <p><a href="https://auth0.com/docs/api#!#get–api-clients–client-id–users" target="_parent" title="https://auth0.com/docs/api#!#get–api-clients–client-id–users">https://auth0.com/docs/api#!#get–api-clients–client-id–users</a>.</p>
160
- </div></span>
161
-
162
- </li>
163
-
164
-
165
- <li class="public ">
166
- <span class="summary_signature">
167
-
168
- <a href="#connection_users-instance_method" title="#connection_users (instance method)">- (Object) <strong>connection_users</strong>(connection_name, search = nil) </a>
169
-
170
-
171
-
172
- (also: #search_connection_users)
173
-
174
- </span>
175
-
176
-
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
- <span class="summary_desc"><div class='inline'>
185
- <p><a href="https://auth0.com/docs/api#!#get–api-connections–connection–users" target="_parent" title="https://auth0.com/docs/api#!#get–api-connections–connection–users">https://auth0.com/docs/api#!#get–api-connections–connection–users</a>
186
- <a href="https://auth0.com/docs/api#!#get–api-connections–connection–users-search–criteria-" target="_parent" title="https://auth0.com/docs/api#!#get–api-connections–connection–users-search–criteria-">https://auth0.com/docs/api#!#get–api-connections–connection–users-search–criteria-</a>.</p>
187
- </div></span>
188
-
189
- </li>
190
-
191
-
192
- <li class="public ">
193
- <span class="summary_signature">
194
-
195
- <a href="#create_public_key-instance_method" title="#create_public_key (instance method)">- (Object) <strong>create_public_key</strong>(user_id, device, public_key) </a>
196
-
197
-
198
-
199
- </span>
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
- <span class="summary_desc"><div class='inline'>
210
- <p><a href="https://auth0.com/docs/api#!#post–api-users–user_id–publickey" target="_parent" title="https://auth0.com/docs/api#!#post–api-users–user_id–publickey">https://auth0.com/docs/api#!#post–api-users–user_id–publickey</a>.</p>
211
- </div></span>
212
-
213
- </li>
214
-
215
-
216
- <li class="public ">
217
- <span class="summary_signature">
218
-
219
- <a href="#create_user-instance_method" title="#create_user (instance method)">- (Object) <strong>create_user</strong>(email, password, connection_name, request_params = {}) </a>
220
-
221
-
222
-
223
- </span>
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
- <span class="summary_desc"><div class='inline'>
234
- <p><a href="https://auth0.com/docs/api#!#post–api-users" target="_parent" title="https://auth0.com/docs/api#!#post–api-users">https://auth0.com/docs/api#!#post–api-users</a>.</p>
235
- </div></span>
236
-
237
- </li>
238
-
239
-
240
- <li class="public ">
241
- <span class="summary_signature">
242
-
243
- <a href="#delete_user-instance_method" title="#delete_user (instance method)">- (Object) <strong>delete_user</strong>(user_id) </a>
244
-
245
-
246
-
247
- </span>
248
-
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
-
257
- <span class="summary_desc"><div class='inline'>
258
- <p><a href="https://auth0.com/docs/api#!#delete–api-users–user_id-" target="_parent" title="https://auth0.com/docs/api#!#delete–api-users–user_id-">https://auth0.com/docs/api#!#delete–api-users–user_id-</a>.</p>
259
- </div></span>
260
-
261
- </li>
262
-
263
-
264
- <li class="public ">
265
- <span class="summary_signature">
266
-
267
- <a href="#delete_users-instance_method" title="#delete_users (instance method)">- (Object) <strong>delete_users</strong> </a>
268
-
269
-
270
-
271
- </span>
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
-
280
-
281
- <span class="summary_desc"><div class='inline'>
282
- <p><a href="https://auth0.com/docs/api#!#delete–api-users" target="_parent" title="https://auth0.com/docs/api#!#delete–api-users">https://auth0.com/docs/api#!#delete–api-users</a>.</p>
283
- </div></span>
284
-
285
- </li>
286
-
287
-
288
- <li class="public ">
289
- <span class="summary_signature">
290
-
291
- <a href="#enterpriseconnections_users-instance_method" title="#enterpriseconnections_users (instance method)">- (Object) <strong>enterpriseconnections_users</strong>(search_criteria = nil, per_page = 500) </a>
292
-
293
-
294
-
295
- </span>
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
-
305
- <span class="summary_desc"><div class='inline'>
306
- <p><a href="https://auth0.com/docs/api#!#get–api-enterpriseconnections-users-search–criteria-" target="_parent" title="https://auth0.com/docs/api#!#get–api-enterpriseconnections-users-search–criteria-">https://auth0.com/docs/api#!#get–api-enterpriseconnections-users-search–criteria-</a>.</p>
307
- </div></span>
308
-
309
- </li>
310
-
311
-
312
- <li class="public ">
313
- <span class="summary_signature">
314
-
315
- <a href="#patch_user_metadata-instance_method" title="#patch_user_metadata (instance method)">- (Object) <strong>patch_user_metadata</strong>(user_id, metadata = {}) </a>
316
-
317
-
318
-
319
- </span>
320
-
321
-
322
-
323
-
324
-
325
-
326
-
327
-
328
-
329
- <span class="summary_desc"><div class='inline'>
330
- <p><a href="https://auth0.com/docs/api#!#patch–api-users–user_id–metadata" target="_parent" title="https://auth0.com/docs/api#!#patch–api-users–user_id–metadata">https://auth0.com/docs/api#!#patch–api-users–user_id–metadata</a>.</p>
331
- </div></span>
332
-
333
- </li>
334
-
335
-
336
- <li class="public ">
337
- <span class="summary_signature">
338
-
339
- <a href="#revoke_user_device_public_key-instance_method" title="#revoke_user_device_public_key (instance method)">- (Object) <strong>revoke_user_device_public_key</strong>(user_id, device) </a>
340
-
341
-
342
-
343
- </span>
344
-
345
-
346
-
347
-
348
-
349
-
350
-
351
-
352
-
353
- <span class="summary_desc"><div class='inline'>
354
- <p><a href="https://auth0.com/docs/api#!#delete–api-users–user_id–publickey-device–device-" target="_parent" title="https://auth0.com/docs/api#!#delete–api-users–user_id–publickey-device–device-">https://auth0.com/docs/api#!#delete–api-users–user_id–publickey-device–device-</a>.</p>
355
- </div></span>
356
-
357
- </li>
358
-
359
-
360
- <li class="public ">
361
- <span class="summary_signature">
362
-
363
- <a href="#revoke_user_refresh_token-instance_method" title="#revoke_user_refresh_token (instance method)">- (Object) <strong>revoke_user_refresh_token</strong>(user_id, refresh_token) </a>
364
-
365
-
366
-
367
- </span>
368
-
369
-
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
- <span class="summary_desc"><div class='inline'>
378
- <p><a href="https://auth0.com/docs/api#!#delete–api-users–user_id–refresh_tokens–refresh_token-" target="_parent" title="https://auth0.com/docs/api#!#delete–api-users–user_id–refresh_tokens–refresh_token-">https://auth0.com/docs/api#!#delete–api-users–user_id–refresh_tokens–refresh_token-</a>.</p>
379
- </div></span>
380
-
381
- </li>
382
-
383
-
384
- <li class="public ">
385
- <span class="summary_signature">
386
-
387
- <a href="#send_verification_email-instance_method" title="#send_verification_email (instance method)">- (Object) <strong>send_verification_email</strong>(user_id) </a>
388
-
389
-
390
-
391
- </span>
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
- <span class="summary_desc"><div class='inline'>
402
- <p><a href="https://auth0.com/docs/api#!#post–api-users–user_id–send_verification_email" target="_parent" title="https://auth0.com/docs/api#!#post–api-users–user_id–send_verification_email">https://auth0.com/docs/api#!#post–api-users–user_id–send_verification_email</a>.</p>
403
- </div></span>
404
-
405
- </li>
406
-
407
-
408
- <li class="public ">
409
- <span class="summary_signature">
410
-
411
- <a href="#socialconnections_users-instance_method" title="#socialconnections_users (instance method)">- (Object) <strong>socialconnections_users</strong>(search_criteria = nil, per_page = 500) </a>
412
-
413
-
414
-
415
- </span>
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
- <span class="summary_desc"><div class='inline'>
426
- <p><a href="https://auth0.com/docs/api#!#get–api-socialconnections-users-search–criteria-" target="_parent" title="https://auth0.com/docs/api#!#get–api-socialconnections-users-search–criteria-">https://auth0.com/docs/api#!#get–api-socialconnections-users-search–criteria-</a>.</p>
427
- </div></span>
428
-
429
- </li>
430
-
431
-
432
- <li class="public ">
433
- <span class="summary_signature">
434
-
435
- <a href="#update_user_email-instance_method" title="#update_user_email (instance method)">- (Object) <strong>update_user_email</strong>(user_id, email, verify = true) </a>
436
-
437
-
438
-
439
- </span>
440
-
441
-
442
-
443
-
444
-
445
-
446
-
447
-
448
-
449
- <span class="summary_desc"><div class='inline'>
450
- <p><a href="https://auth0.com/docs/api#!#put–api-users–user_id–email" target="_parent" title="https://auth0.com/docs/api#!#put–api-users–user_id–email">https://auth0.com/docs/api#!#put–api-users–user_id–email</a>.</p>
451
- </div></span>
452
-
453
- </li>
454
-
455
-
456
- <li class="public ">
457
- <span class="summary_signature">
458
-
459
- <a href="#update_user_metadata-instance_method" title="#update_user_metadata (instance method)">- (Object) <strong>update_user_metadata</strong>(user_id, metadata = {}) </a>
460
-
461
-
462
-
463
- </span>
464
-
465
-
466
-
467
-
468
-
469
-
470
-
471
-
472
-
473
- <span class="summary_desc"><div class='inline'>
474
- <p><a href="https://auth0.com/docs/api#!#put–api-users–user_id–metadata" target="_parent" title="https://auth0.com/docs/api#!#put–api-users–user_id–metadata">https://auth0.com/docs/api#!#put–api-users–user_id–metadata</a> This will
475
- overwrite user&#39;s metadata, be really carefull, preffer using patch
476
- instead.</p>
477
- </div></span>
478
-
479
- </li>
480
-
481
-
482
- <li class="public ">
483
- <span class="summary_signature">
484
-
485
- <a href="#update_user_password-instance_method" title="#update_user_password (instance method)">- (Object) <strong>update_user_password</strong>(user_id, password, verify = true) </a>
486
-
487
-
488
-
489
- </span>
490
-
491
-
492
-
493
-
494
-
495
-
496
-
497
-
498
-
499
- <span class="summary_desc"><div class='inline'>
500
- <p><a href="https://auth0.com/docs/api#!#put–api-users–user_id–password" target="_parent" title="https://auth0.com/docs/api#!#put–api-users–user_id–password">https://auth0.com/docs/api#!#put–api-users–user_id–password</a>.</p>
501
- </div></span>
502
-
503
- </li>
504
-
505
-
506
- <li class="public ">
507
- <span class="summary_signature">
508
-
509
- <a href="#update_user_password_using_email-instance_method" title="#update_user_password_using_email (instance method)">- (Object) <strong>update_user_password_using_email</strong>(email, password, connection_name, verify = true) </a>
510
-
511
-
512
-
513
- </span>
514
-
515
-
516
-
517
-
518
-
519
-
520
-
521
-
522
-
523
- <span class="summary_desc"><div class='inline'>
524
- <p><a href="https://auth0.com/docs/api#!#put–api-users–email–password" target="_parent" title="https://auth0.com/docs/api#!#put–api-users–email–password">https://auth0.com/docs/api#!#put–api-users–email–password</a>.</p>
525
- </div></span>
526
-
527
- </li>
528
-
529
-
530
- <li class="public ">
531
- <span class="summary_signature">
532
-
533
- <a href="#user-instance_method" title="#user (instance method)">- (Object) <strong>user</strong>(user_id) </a>
534
-
535
-
536
-
537
- (also: #get_user)
538
-
539
- </span>
540
-
541
-
542
-
543
-
544
-
545
-
546
-
547
-
548
-
549
- <span class="summary_desc"><div class='inline'>
550
- <p><a href="https://auth0.com/docs/api#!#get–api-users–user_id-" target="_parent" title="https://auth0.com/docs/api#!#get–api-users–user_id-">https://auth0.com/docs/api#!#get–api-users–user_id-</a>.</p>
551
- </div></span>
552
-
553
- </li>
554
-
555
-
556
- <li class="public ">
557
- <span class="summary_signature">
558
-
559
- <a href="#user_devices-instance_method" title="#user_devices (instance method)">- (Object) <strong>user_devices</strong>(user_id) </a>
560
-
561
-
562
-
563
- </span>
564
-
565
-
566
-
567
-
568
-
569
-
570
-
571
-
572
-
573
- <span class="summary_desc"><div class='inline'>
574
- <p><a href="https://auth0.com/docs/api#!#get–api-users–user_id–devices" target="_parent" title="https://auth0.com/docs/api#!#get–api-users–user_id–devices">https://auth0.com/docs/api#!#get–api-users–user_id–devices</a>.</p>
575
- </div></span>
576
-
577
- </li>
578
-
579
-
580
- <li class="public ">
581
- <span class="summary_signature">
582
-
583
- <a href="#users-instance_method" title="#users (instance method)">- (Object) <strong>users</strong>(search = nil) </a>
584
-
585
-
586
-
587
- (also: #users_search, #get_users)
588
-
589
- </span>
590
-
591
-
592
-
593
-
594
-
595
-
596
-
597
-
598
-
599
- <span class="summary_desc"><div class='inline'>
600
- <p><a href="https://auth0.com/docs/api#!#get–api-users" target="_parent" title="https://auth0.com/docs/api#!#get–api-users">https://auth0.com/docs/api#!#get–api-users</a>.</p>
601
- </div></span>
602
-
603
- </li>
604
-
605
-
606
- <li class="public ">
607
- <span class="summary_signature">
608
-
609
- <a href="#verification_ticket-instance_method" title="#verification_ticket (instance method)">- (Object) <strong>verification_ticket</strong>(user_id, result_url = nil) </a>
610
-
611
-
612
-
613
- </span>
614
-
615
-
616
-
617
-
618
-
619
-
620
-
621
-
622
-
623
- <span class="summary_desc"><div class='inline'>
624
- <p><a href="https://auth0.com/docs/api#!#post–api-users–user_id–verification_ticket" target="_parent" title="https://auth0.com/docs/api#!#post–api-users–user_id–verification_ticket">https://auth0.com/docs/api#!#post–api-users–user_id–verification_ticket</a>.</p>
625
- </div></span>
626
-
627
- </li>
628
-
629
-
630
- </ul>
631
-
632
-
633
-
634
-
635
- <div id="instance_method_details" class="method_details_list">
636
- <h2>Instance Method Details</h2>
637
-
638
-
639
- <div class="method_details first">
640
- <h3 class="signature first" id="change_password_ticket-instance_method">
641
-
642
- - (<tt>Object</tt>) <strong>change_password_ticket</strong>(user_id, new_password, result_url = nil)
643
-
644
-
645
-
646
-
647
-
648
- </h3><div class="docstring">
649
- <div class="discussion">
650
-
651
- <p><a href="https://auth0.com/docs/api#!#post–api-users–user_id–change_password_ticket" target="_parent" title="https://auth0.com/docs/api#!#post–api-users–user_id–change_password_ticket">https://auth0.com/docs/api#!#post–api-users–user_id–change_password_ticket</a></p>
652
-
653
-
654
- </div>
655
- </div>
656
- <div class="tags">
657
-
658
-
659
- </div><table class="source_code">
660
- <tr>
661
- <td>
662
- <pre class="lines">
663
-
664
-
665
- 75
666
- 76
667
- 77
668
- 78
669
- 79</pre>
670
- </td>
671
- <td>
672
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 75</span>
673
-
674
- <span class='kw'>def</span> <span class='id identifier rubyid_change_password_ticket'>change_password_ticket</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_new_password'>new_password</span><span class='comma'>,</span> <span class='id identifier rubyid_result_url'>result_url</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
675
- <span class='id identifier rubyid_request_params'>request_params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>newPassword</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_new_password'>new_password</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>resultUrl</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_result_url'>result_url</span> <span class='rbrace'>}</span>
676
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/change_password_ticket</span><span class='tstring_end'>&quot;</span></span>
677
- <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_request_params'>request_params</span><span class='rparen'>)</span>
678
- <span class='kw'>end</span></pre>
679
- </td>
680
- </tr>
681
- </table>
682
- </div>
683
-
684
- <div class="method_details ">
685
- <h3 class="signature " id="client_users-instance_method">
686
-
687
- - (<tt>Object</tt>) <strong>client_users</strong>(client_id = @client_id)
688
-
689
-
690
-
691
-
692
-
693
- </h3><div class="docstring">
694
- <div class="discussion">
695
-
696
- <p><a href="https://auth0.com/docs/api#!#get–api-clients–client-id–users" target="_parent" title="https://auth0.com/docs/api#!#get–api-clients–client-id–users">https://auth0.com/docs/api#!#get–api-clients–client-id–users</a></p>
697
-
698
-
699
- </div>
700
- </div>
701
- <div class="tags">
702
-
703
-
704
- </div><table class="source_code">
705
- <tr>
706
- <td>
707
- <pre class="lines">
708
-
709
-
710
- 55
711
- 56
712
- 57
713
- 58</pre>
714
- </td>
715
- <td>
716
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 55</span>
717
-
718
- <span class='kw'>def</span> <span class='id identifier rubyid_client_users'>client_users</span><span class='lparen'>(</span><span class='id identifier rubyid_client_id'>client_id</span><span class='op'>=</span><span class='ivar'>@client_id</span><span class='rparen'>)</span>
719
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/clients/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_client_id'>client_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/users</span><span class='tstring_end'>&quot;</span></span>
720
- <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
721
- <span class='kw'>end</span></pre>
722
- </td>
723
- </tr>
724
- </table>
725
- </div>
726
-
727
- <div class="method_details ">
728
- <h3 class="signature " id="connection_users-instance_method">
729
-
730
- - (<tt>Object</tt>) <strong>connection_users</strong>(connection_name, search = nil)
731
-
732
-
733
-
734
- <span class="aliases">Also known as:
735
- <span class="names"><span id='search_connection_users-instance_method'>search_connection_users</span></span>
736
- </span>
737
-
738
-
739
-
740
- </h3><div class="docstring">
741
- <div class="discussion">
742
-
743
- <p><a href="https://auth0.com/docs/api#!#get–api-connections–connection–users" target="_parent" title="https://auth0.com/docs/api#!#get–api-connections–connection–users">https://auth0.com/docs/api#!#get–api-connections–connection–users</a>
744
- <a href="https://auth0.com/docs/api#!#get–api-connections–connection–users-search–criteria-" target="_parent" title="https://auth0.com/docs/api#!#get–api-connections–connection–users-search–criteria-">https://auth0.com/docs/api#!#get–api-connections–connection–users-search–criteria-</a></p>
745
-
746
-
747
- </div>
748
- </div>
749
- <div class="tags">
750
-
751
-
752
- </div><table class="source_code">
753
- <tr>
754
- <td>
755
- <pre class="lines">
756
-
757
-
758
- 34
759
- 35
760
- 36
761
- 37
762
- 38</pre>
763
- </td>
764
- <td>
765
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 34</span>
766
-
767
- <span class='kw'>def</span> <span class='id identifier rubyid_connection_users'>connection_users</span><span class='lparen'>(</span><span class='id identifier rubyid_connection_name'>connection_name</span><span class='comma'>,</span> <span class='id identifier rubyid_search'>search</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
768
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/connections/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_connection_name'>connection_name</span><span class='embexpr_end'>}</span><span class='tstring_content'>/users</span><span class='tstring_end'>&quot;</span></span>
769
- <span class='id identifier rubyid_path'>path</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>?search=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_search'>search</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_search'>search</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
770
- <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
771
- <span class='kw'>end</span></pre>
772
- </td>
773
- </tr>
774
- </table>
775
- </div>
776
-
777
- <div class="method_details ">
778
- <h3 class="signature " id="create_public_key-instance_method">
779
-
780
- - (<tt>Object</tt>) <strong>create_public_key</strong>(user_id, device, public_key)
781
-
782
-
783
-
784
-
785
-
786
- </h3><div class="docstring">
787
- <div class="discussion">
788
-
789
- <p><a href="https://auth0.com/docs/api#!#post–api-users–user_id–publickey" target="_parent" title="https://auth0.com/docs/api#!#post–api-users–user_id–publickey">https://auth0.com/docs/api#!#post–api-users–user_id–publickey</a></p>
790
-
791
-
792
- </div>
793
- </div>
794
- <div class="tags">
795
-
796
-
797
- </div><table class="source_code">
798
- <tr>
799
- <td>
800
- <pre class="lines">
801
-
802
-
803
- 89
804
- 90
805
- 91
806
- 92
807
- 93</pre>
808
- </td>
809
- <td>
810
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 89</span>
811
-
812
- <span class='kw'>def</span> <span class='id identifier rubyid_create_public_key'>create_public_key</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_device'>device</span><span class='comma'>,</span> <span class='id identifier rubyid_public_key'>public_key</span><span class='rparen'>)</span>
813
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/public_key</span><span class='tstring_end'>&quot;</span></span>
814
- <span class='id identifier rubyid_request_params'>request_params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>device:</span> <span class='id identifier rubyid_device'>device</span><span class='comma'>,</span> <span class='label'>public_key:</span> <span class='id identifier rubyid_public_key'>public_key</span> <span class='rbrace'>}</span>
815
- <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_request_params'>request_params</span><span class='rparen'>)</span>
816
- <span class='kw'>end</span></pre>
817
- </td>
818
- </tr>
819
- </table>
820
- </div>
821
-
822
- <div class="method_details ">
823
- <h3 class="signature " id="create_user-instance_method">
824
-
825
- - (<tt>Object</tt>) <strong>create_user</strong>(email, password, connection_name, request_params = {})
826
-
827
-
828
-
829
-
830
-
831
- </h3><div class="docstring">
832
- <div class="discussion">
833
-
834
- <p><a href="https://auth0.com/docs/api#!#post–api-users" target="_parent" title="https://auth0.com/docs/api#!#post–api-users">https://auth0.com/docs/api#!#post–api-users</a></p>
835
-
836
-
837
- </div>
838
- </div>
839
- <div class="tags">
840
-
841
-
842
- </div><table class="source_code">
843
- <tr>
844
- <td>
845
- <pre class="lines">
846
-
847
-
848
- 61
849
- 62
850
- 63
851
- 64
852
- 65
853
- 66</pre>
854
- </td>
855
- <td>
856
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 61</span>
857
-
858
- <span class='kw'>def</span> <span class='id identifier rubyid_create_user'>create_user</span><span class='lparen'>(</span><span class='id identifier rubyid_email'>email</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='comma'>,</span> <span class='id identifier rubyid_connection_name'>connection_name</span><span class='comma'>,</span> <span class='id identifier rubyid_request_params'>request_params</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
859
- <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>email:</span> <span class='id identifier rubyid_email'>email</span><span class='comma'>,</span> <span class='label'>password:</span> <span class='id identifier rubyid_password'>password</span><span class='comma'>,</span> <span class='label'>connection:</span> <span class='id identifier rubyid_connection_name'>connection_name</span> <span class='rbrace'>}</span>
860
- <span class='id identifier rubyid_request_params'>request_params</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
861
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users</span><span class='tstring_end'>&quot;</span></span>
862
- <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_request_params'>request_params</span><span class='rparen'>)</span>
863
- <span class='kw'>end</span></pre>
864
- </td>
865
- </tr>
866
- </table>
867
- </div>
868
-
869
- <div class="method_details ">
870
- <h3 class="signature " id="delete_user-instance_method">
871
-
872
- - (<tt>Object</tt>) <strong>delete_user</strong>(user_id)
873
-
874
-
875
-
876
-
877
-
878
- </h3><div class="docstring">
879
- <div class="discussion">
880
-
881
- <p><a href="https://auth0.com/docs/api#!#delete–api-users–user_id-" target="_parent" title="https://auth0.com/docs/api#!#delete–api-users–user_id-">https://auth0.com/docs/api#!#delete–api-users–user_id-</a></p>
882
-
883
-
884
- </div>
885
- </div>
886
- <div class="tags">
887
-
888
- <p class="tag_title">Raises:</p>
889
- <ul class="raise">
890
-
891
- <li>
892
-
893
-
894
- <span class='type'>(<tt><span class='object_link'><a href="../../UserIdIsBlank.html" title="Auth0::UserIdIsBlank (class)">Auth0::UserIdIsBlank</a></span></tt>)</span>
895
-
896
-
897
-
898
- </li>
899
-
900
- </ul>
901
-
902
- </div><table class="source_code">
903
- <tr>
904
- <td>
905
- <pre class="lines">
906
-
907
-
908
- 143
909
- 144
910
- 145
911
- 146
912
- 147</pre>
913
- </td>
914
- <td>
915
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 143</span>
916
-
917
- <span class='kw'>def</span> <span class='id identifier rubyid_delete_user'>delete_user</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='rparen'>)</span>
918
- <span class='id identifier rubyid_raise'>raise</span> <span class='const'>Auth0</span><span class='op'>::</span><span class='const'>UserIdIsBlank</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>if you want to remove all users user delete_users method</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
919
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
920
- <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
921
- <span class='kw'>end</span></pre>
922
- </td>
923
- </tr>
924
- </table>
925
- </div>
926
-
927
- <div class="method_details ">
928
- <h3 class="signature " id="delete_users-instance_method">
929
-
930
- - (<tt>Object</tt>) <strong>delete_users</strong>
931
-
932
-
933
-
934
-
935
-
936
- </h3><div class="docstring">
937
- <div class="discussion">
938
-
939
- <p><a href="https://auth0.com/docs/api#!#delete–api-users" target="_parent" title="https://auth0.com/docs/api#!#delete–api-users">https://auth0.com/docs/api#!#delete–api-users</a></p>
940
-
941
- <p>This will remove all your users</p>
942
-
943
-
944
- </div>
945
- </div>
946
- <div class="tags">
947
-
948
-
949
- </div><table class="source_code">
950
- <tr>
951
- <td>
952
- <pre class="lines">
953
-
954
-
955
- 137
956
- 138
957
- 139
958
- 140</pre>
959
- </td>
960
- <td>
961
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 137</span>
962
-
963
- <span class='kw'>def</span> <span class='id identifier rubyid_delete_users'>delete_users</span>
964
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/</span><span class='tstring_end'>&quot;</span></span>
965
- <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
966
- <span class='kw'>end</span></pre>
967
- </td>
968
- </tr>
969
- </table>
970
- </div>
971
-
972
- <div class="method_details ">
973
- <h3 class="signature " id="enterpriseconnections_users-instance_method">
974
-
975
- - (<tt>Object</tt>) <strong>enterpriseconnections_users</strong>(search_criteria = nil, per_page = 500)
976
-
977
-
978
-
979
-
980
-
981
- </h3><div class="docstring">
982
- <div class="discussion">
983
-
984
- <p><a href="https://auth0.com/docs/api#!#get–api-enterpriseconnections-users-search–criteria-" target="_parent" title="https://auth0.com/docs/api#!#get–api-enterpriseconnections-users-search–criteria-">https://auth0.com/docs/api#!#get–api-enterpriseconnections-users-search–criteria-</a></p>
985
-
986
-
987
- </div>
988
- </div>
989
- <div class="tags">
990
-
991
-
992
- </div><table class="source_code">
993
- <tr>
994
- <td>
995
- <pre class="lines">
996
-
997
-
998
- 43
999
- 44
1000
- 45
1001
- 46</pre>
1002
- </td>
1003
- <td>
1004
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 43</span>
1005
-
1006
- <span class='kw'>def</span> <span class='id identifier rubyid_enterpriseconnections_users'>enterpriseconnections_users</span><span class='lparen'>(</span><span class='id identifier rubyid_search_criteria'>search_criteria</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_per_page'>per_page</span><span class='op'>=</span><span class='int'>500</span><span class='rparen'>)</span>
1007
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/enterpriseconnections/users?search=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_search_criteria'>search_criteria</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='embexpr_end'>}</span><span class='tstring_content'>&amp;per_page=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_per_page'>per_page</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1008
- <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
1009
- <span class='kw'>end</span></pre>
1010
- </td>
1011
- </tr>
1012
- </table>
1013
- </div>
1014
-
1015
- <div class="method_details ">
1016
- <h3 class="signature " id="patch_user_metadata-instance_method">
1017
-
1018
- - (<tt>Object</tt>) <strong>patch_user_metadata</strong>(user_id, metadata = {})
1019
-
1020
-
1021
-
1022
-
1023
-
1024
- </h3><div class="docstring">
1025
- <div class="discussion">
1026
-
1027
- <p><a href="https://auth0.com/docs/api#!#patch–api-users–user_id–metadata" target="_parent" title="https://auth0.com/docs/api#!#patch–api-users–user_id–metadata">https://auth0.com/docs/api#!#patch–api-users–user_id–metadata</a></p>
1028
-
1029
-
1030
- </div>
1031
- </div>
1032
- <div class="tags">
1033
-
1034
-
1035
- </div><table class="source_code">
1036
- <tr>
1037
- <td>
1038
- <pre class="lines">
1039
-
1040
-
1041
- 129
1042
- 130
1043
- 131
1044
- 132</pre>
1045
- </td>
1046
- <td>
1047
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 129</span>
1048
-
1049
- <span class='kw'>def</span> <span class='id identifier rubyid_patch_user_metadata'>patch_user_metadata</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1050
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/metadata</span><span class='tstring_end'>&quot;</span></span>
1051
- <span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='rparen'>)</span>
1052
- <span class='kw'>end</span></pre>
1053
- </td>
1054
- </tr>
1055
- </table>
1056
- </div>
1057
-
1058
- <div class="method_details ">
1059
- <h3 class="signature " id="revoke_user_device_public_key-instance_method">
1060
-
1061
- - (<tt>Object</tt>) <strong>revoke_user_device_public_key</strong>(user_id, device)
1062
-
1063
-
1064
-
1065
-
1066
-
1067
- </h3><div class="docstring">
1068
- <div class="discussion">
1069
-
1070
- <p><a href="https://auth0.com/docs/api#!#delete–api-users–user_id–publickey-device–device-" target="_parent" title="https://auth0.com/docs/api#!#delete–api-users–user_id–publickey-device–device-">https://auth0.com/docs/api#!#delete–api-users–user_id–publickey-device–device-</a></p>
1071
-
1072
-
1073
- </div>
1074
- </div>
1075
- <div class="tags">
1076
-
1077
-
1078
- </div><table class="source_code">
1079
- <tr>
1080
- <td>
1081
- <pre class="lines">
1082
-
1083
-
1084
- 156
1085
- 157
1086
- 158
1087
- 159</pre>
1088
- </td>
1089
- <td>
1090
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 156</span>
1091
-
1092
- <span class='kw'>def</span> <span class='id identifier rubyid_revoke_user_device_public_key'>revoke_user_device_public_key</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_device'>device</span><span class='rparen'>)</span>
1093
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/publickey?device=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_device'>device</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1094
- <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
1095
- <span class='kw'>end</span></pre>
1096
- </td>
1097
- </tr>
1098
- </table>
1099
- </div>
1100
-
1101
- <div class="method_details ">
1102
- <h3 class="signature " id="revoke_user_refresh_token-instance_method">
1103
-
1104
- - (<tt>Object</tt>) <strong>revoke_user_refresh_token</strong>(user_id, refresh_token)
1105
-
1106
-
1107
-
1108
-
1109
-
1110
- </h3><div class="docstring">
1111
- <div class="discussion">
1112
-
1113
- <p><a href="https://auth0.com/docs/api#!#delete–api-users–user_id–refresh_tokens–refresh_token-" target="_parent" title="https://auth0.com/docs/api#!#delete–api-users–user_id–refresh_tokens–refresh_token-">https://auth0.com/docs/api#!#delete–api-users–user_id–refresh_tokens–refresh_token-</a></p>
1114
-
1115
-
1116
- </div>
1117
- </div>
1118
- <div class="tags">
1119
-
1120
-
1121
- </div><table class="source_code">
1122
- <tr>
1123
- <td>
1124
- <pre class="lines">
1125
-
1126
-
1127
- 150
1128
- 151
1129
- 152
1130
- 153</pre>
1131
- </td>
1132
- <td>
1133
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 150</span>
1134
-
1135
- <span class='kw'>def</span> <span class='id identifier rubyid_revoke_user_refresh_token'>revoke_user_refresh_token</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_refresh_token'>refresh_token</span><span class='rparen'>)</span>
1136
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/refresh_tokens/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_refresh_token'>refresh_token</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1137
- <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
1138
- <span class='kw'>end</span></pre>
1139
- </td>
1140
- </tr>
1141
- </table>
1142
- </div>
1143
-
1144
- <div class="method_details ">
1145
- <h3 class="signature " id="send_verification_email-instance_method">
1146
-
1147
- - (<tt>Object</tt>) <strong>send_verification_email</strong>(user_id)
1148
-
1149
-
1150
-
1151
-
1152
-
1153
- </h3><div class="docstring">
1154
- <div class="discussion">
1155
-
1156
- <p><a href="https://auth0.com/docs/api#!#post–api-users–user_id–send_verification_email" target="_parent" title="https://auth0.com/docs/api#!#post–api-users–user_id–send_verification_email">https://auth0.com/docs/api#!#post–api-users–user_id–send_verification_email</a></p>
1157
-
1158
-
1159
- </div>
1160
- </div>
1161
- <div class="tags">
1162
-
1163
-
1164
- </div><table class="source_code">
1165
- <tr>
1166
- <td>
1167
- <pre class="lines">
1168
-
1169
-
1170
- 69
1171
- 70
1172
- 71
1173
- 72</pre>
1174
- </td>
1175
- <td>
1176
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 69</span>
1177
-
1178
- <span class='kw'>def</span> <span class='id identifier rubyid_send_verification_email'>send_verification_email</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='rparen'>)</span>
1179
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/send_verification_email</span><span class='tstring_end'>&quot;</span></span>
1180
- <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
1181
- <span class='kw'>end</span></pre>
1182
- </td>
1183
- </tr>
1184
- </table>
1185
- </div>
1186
-
1187
- <div class="method_details ">
1188
- <h3 class="signature " id="socialconnections_users-instance_method">
1189
-
1190
- - (<tt>Object</tt>) <strong>socialconnections_users</strong>(search_criteria = nil, per_page = 500)
1191
-
1192
-
1193
-
1194
-
1195
-
1196
- </h3><div class="docstring">
1197
- <div class="discussion">
1198
-
1199
- <p><a href="https://auth0.com/docs/api#!#get–api-socialconnections-users-search–criteria-" target="_parent" title="https://auth0.com/docs/api#!#get–api-socialconnections-users-search–criteria-">https://auth0.com/docs/api#!#get–api-socialconnections-users-search–criteria-</a></p>
1200
-
1201
-
1202
- </div>
1203
- </div>
1204
- <div class="tags">
1205
-
1206
-
1207
- </div><table class="source_code">
1208
- <tr>
1209
- <td>
1210
- <pre class="lines">
1211
-
1212
-
1213
- 49
1214
- 50
1215
- 51
1216
- 52</pre>
1217
- </td>
1218
- <td>
1219
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 49</span>
1220
-
1221
- <span class='kw'>def</span> <span class='id identifier rubyid_socialconnections_users'>socialconnections_users</span><span class='lparen'>(</span><span class='id identifier rubyid_search_criteria'>search_criteria</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_per_page'>per_page</span><span class='op'>=</span><span class='int'>500</span><span class='rparen'>)</span>
1222
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/socialconnections/users?search=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_search_criteria'>search_criteria</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='embexpr_end'>}</span><span class='tstring_content'>&amp;per_page=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_per_page'>per_page</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1223
- <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
1224
- <span class='kw'>end</span></pre>
1225
- </td>
1226
- </tr>
1227
- </table>
1228
- </div>
1229
-
1230
- <div class="method_details ">
1231
- <h3 class="signature " id="update_user_email-instance_method">
1232
-
1233
- - (<tt>Object</tt>) <strong>update_user_email</strong>(user_id, email, verify = true)
1234
-
1235
-
1236
-
1237
-
1238
-
1239
- </h3><div class="docstring">
1240
- <div class="discussion">
1241
-
1242
- <p><a href="https://auth0.com/docs/api#!#put–api-users–user_id–email" target="_parent" title="https://auth0.com/docs/api#!#put–api-users–user_id–email">https://auth0.com/docs/api#!#put–api-users–user_id–email</a></p>
1243
-
1244
-
1245
- </div>
1246
- </div>
1247
- <div class="tags">
1248
-
1249
-
1250
- </div><table class="source_code">
1251
- <tr>
1252
- <td>
1253
- <pre class="lines">
1254
-
1255
-
1256
- 96
1257
- 97
1258
- 98
1259
- 99
1260
- 100</pre>
1261
- </td>
1262
- <td>
1263
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 96</span>
1264
-
1265
- <span class='kw'>def</span> <span class='id identifier rubyid_update_user_email'>update_user_email</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_email'>email</span><span class='comma'>,</span> <span class='id identifier rubyid_verify'>verify</span><span class='op'>=</span><span class='kw'>true</span><span class='rparen'>)</span>
1266
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/email</span><span class='tstring_end'>&quot;</span></span>
1267
- <span class='id identifier rubyid_request_params'>request_params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>email:</span> <span class='id identifier rubyid_email'>email</span><span class='comma'>,</span> <span class='label'>verify:</span> <span class='id identifier rubyid_verify'>verify</span> <span class='rbrace'>}</span>
1268
- <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_request_params'>request_params</span><span class='rparen'>)</span>
1269
- <span class='kw'>end</span></pre>
1270
- </td>
1271
- </tr>
1272
- </table>
1273
- </div>
1274
-
1275
- <div class="method_details ">
1276
- <h3 class="signature " id="update_user_metadata-instance_method">
1277
-
1278
- - (<tt>Object</tt>) <strong>update_user_metadata</strong>(user_id, metadata = {})
1279
-
1280
-
1281
-
1282
-
1283
-
1284
- </h3><div class="docstring">
1285
- <div class="discussion">
1286
-
1287
- <p><a href="https://auth0.com/docs/api#!#put–api-users–user_id–metadata" target="_parent" title="https://auth0.com/docs/api#!#put–api-users–user_id–metadata">https://auth0.com/docs/api#!#put–api-users–user_id–metadata</a> This will
1288
- overwrite user&#39;s metadata, be really carefull, preffer using patch
1289
- instead</p>
1290
-
1291
-
1292
- </div>
1293
- </div>
1294
- <div class="tags">
1295
-
1296
-
1297
- </div><table class="source_code">
1298
- <tr>
1299
- <td>
1300
- <pre class="lines">
1301
-
1302
-
1303
- 104
1304
- 105
1305
- 106
1306
- 107</pre>
1307
- </td>
1308
- <td>
1309
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 104</span>
1310
-
1311
- <span class='kw'>def</span> <span class='id identifier rubyid_update_user_metadata'>update_user_metadata</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1312
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/metadata</span><span class='tstring_end'>&quot;</span></span>
1313
- <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='rparen'>)</span>
1314
- <span class='kw'>end</span></pre>
1315
- </td>
1316
- </tr>
1317
- </table>
1318
- </div>
1319
-
1320
- <div class="method_details ">
1321
- <h3 class="signature " id="update_user_password-instance_method">
1322
-
1323
- - (<tt>Object</tt>) <strong>update_user_password</strong>(user_id, password, verify = true)
1324
-
1325
-
1326
-
1327
-
1328
-
1329
- </h3><div class="docstring">
1330
- <div class="discussion">
1331
-
1332
- <p><a href="https://auth0.com/docs/api#!#put–api-users–user_id–password" target="_parent" title="https://auth0.com/docs/api#!#put–api-users–user_id–password">https://auth0.com/docs/api#!#put–api-users–user_id–password</a></p>
1333
-
1334
-
1335
- </div>
1336
- </div>
1337
- <div class="tags">
1338
-
1339
-
1340
- </div><table class="source_code">
1341
- <tr>
1342
- <td>
1343
- <pre class="lines">
1344
-
1345
-
1346
- 110
1347
- 111
1348
- 112
1349
- 113
1350
- 114</pre>
1351
- </td>
1352
- <td>
1353
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 110</span>
1354
-
1355
- <span class='kw'>def</span> <span class='id identifier rubyid_update_user_password'>update_user_password</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='comma'>,</span> <span class='id identifier rubyid_verify'>verify</span><span class='op'>=</span><span class='kw'>true</span><span class='rparen'>)</span>
1356
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/password</span><span class='tstring_end'>&quot;</span></span>
1357
- <span class='id identifier rubyid_request_params'>request_params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>password:</span> <span class='id identifier rubyid_password'>password</span><span class='comma'>,</span> <span class='label'>verify:</span> <span class='id identifier rubyid_verify'>verify</span> <span class='rbrace'>}</span>
1358
- <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_request_params'>request_params</span><span class='rparen'>)</span>
1359
- <span class='kw'>end</span></pre>
1360
- </td>
1361
- </tr>
1362
- </table>
1363
- </div>
1364
-
1365
- <div class="method_details ">
1366
- <h3 class="signature " id="update_user_password_using_email-instance_method">
1367
-
1368
- - (<tt>Object</tt>) <strong>update_user_password_using_email</strong>(email, password, connection_name, verify = true)
1369
-
1370
-
1371
-
1372
-
1373
-
1374
- </h3><div class="docstring">
1375
- <div class="discussion">
1376
-
1377
- <p><a href="https://auth0.com/docs/api#!#put–api-users–email–password" target="_parent" title="https://auth0.com/docs/api#!#put–api-users–email–password">https://auth0.com/docs/api#!#put–api-users–email–password</a></p>
1378
-
1379
-
1380
- </div>
1381
- </div>
1382
- <div class="tags">
1383
-
1384
-
1385
- </div><table class="source_code">
1386
- <tr>
1387
- <td>
1388
- <pre class="lines">
1389
-
1390
-
1391
- 117
1392
- 118
1393
- 119
1394
- 120
1395
- 121
1396
- 122
1397
- 123
1398
- 124
1399
- 125
1400
- 126</pre>
1401
- </td>
1402
- <td>
1403
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 117</span>
1404
-
1405
- <span class='kw'>def</span> <span class='id identifier rubyid_update_user_password_using_email'>update_user_password_using_email</span><span class='lparen'>(</span><span class='id identifier rubyid_email'>email</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='comma'>,</span> <span class='id identifier rubyid_connection_name'>connection_name</span><span class='comma'>,</span> <span class='id identifier rubyid_verify'>verify</span><span class='op'>=</span><span class='kw'>true</span><span class='rparen'>)</span>
1406
- <span class='id identifier rubyid_request_params'>request_params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1407
- <span class='label'>email:</span> <span class='id identifier rubyid_email'>email</span><span class='comma'>,</span>
1408
- <span class='label'>password:</span> <span class='id identifier rubyid_password'>password</span><span class='comma'>,</span>
1409
- <span class='label'>connection:</span> <span class='id identifier rubyid_connection_name'>connection_name</span><span class='comma'>,</span>
1410
- <span class='label'>verify:</span> <span class='id identifier rubyid_verify'>verify</span>
1411
- <span class='rbrace'>}</span>
1412
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_email'>email</span><span class='embexpr_end'>}</span><span class='tstring_content'>/password</span><span class='tstring_end'>&quot;</span></span>
1413
- <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_request_params'>request_params</span><span class='rparen'>)</span>
1414
- <span class='kw'>end</span></pre>
1415
- </td>
1416
- </tr>
1417
- </table>
1418
- </div>
1419
-
1420
- <div class="method_details ">
1421
- <h3 class="signature " id="user-instance_method">
1422
-
1423
- - (<tt>Object</tt>) <strong>user</strong>(user_id)
1424
-
1425
-
1426
-
1427
- <span class="aliases">Also known as:
1428
- <span class="names"><span id='get_user-instance_method'>get_user</span></span>
1429
- </span>
1430
-
1431
-
1432
-
1433
- </h3><div class="docstring">
1434
- <div class="discussion">
1435
-
1436
- <p><a href="https://auth0.com/docs/api#!#get–api-users–user_id-" target="_parent" title="https://auth0.com/docs/api#!#get–api-users–user_id-">https://auth0.com/docs/api#!#get–api-users–user_id-</a></p>
1437
-
1438
-
1439
- </div>
1440
- </div>
1441
- <div class="tags">
1442
-
1443
-
1444
- </div><table class="source_code">
1445
- <tr>
1446
- <td>
1447
- <pre class="lines">
1448
-
1449
-
1450
- 19
1451
- 20
1452
- 21
1453
- 22</pre>
1454
- </td>
1455
- <td>
1456
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 19</span>
1457
-
1458
- <span class='kw'>def</span> <span class='id identifier rubyid_user'>user</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='rparen'>)</span>
1459
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1460
- <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
1461
- <span class='kw'>end</span></pre>
1462
- </td>
1463
- </tr>
1464
- </table>
1465
- </div>
1466
-
1467
- <div class="method_details ">
1468
- <h3 class="signature " id="user_devices-instance_method">
1469
-
1470
- - (<tt>Object</tt>) <strong>user_devices</strong>(user_id)
1471
-
1472
-
1473
-
1474
-
1475
-
1476
- </h3><div class="docstring">
1477
- <div class="discussion">
1478
-
1479
- <p><a href="https://auth0.com/docs/api#!#get–api-users–user_id–devices" target="_parent" title="https://auth0.com/docs/api#!#get–api-users–user_id–devices">https://auth0.com/docs/api#!#get–api-users–user_id–devices</a></p>
1480
-
1481
-
1482
- </div>
1483
- </div>
1484
- <div class="tags">
1485
-
1486
-
1487
- </div><table class="source_code">
1488
- <tr>
1489
- <td>
1490
- <pre class="lines">
1491
-
1492
-
1493
- 27
1494
- 28
1495
- 29
1496
- 30</pre>
1497
- </td>
1498
- <td>
1499
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 27</span>
1500
-
1501
- <span class='kw'>def</span> <span class='id identifier rubyid_user_devices'>user_devices</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='rparen'>)</span>
1502
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/devices</span><span class='tstring_end'>&quot;</span></span>
1503
- <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
1504
- <span class='kw'>end</span></pre>
1505
- </td>
1506
- </tr>
1507
- </table>
1508
- </div>
1509
-
1510
- <div class="method_details ">
1511
- <h3 class="signature " id="users-instance_method">
1512
-
1513
- - (<tt>Object</tt>) <strong>users</strong>(search = nil)
1514
-
1515
-
1516
-
1517
- <span class="aliases">Also known as:
1518
- <span class="names"><span id='users_search-instance_method'>users_search</span>, <span id='get_users-instance_method'>get_users</span></span>
1519
- </span>
1520
-
1521
-
1522
-
1523
- </h3><div class="docstring">
1524
- <div class="discussion">
1525
-
1526
- <p><a href="https://auth0.com/docs/api#!#get–api-users" target="_parent" title="https://auth0.com/docs/api#!#get–api-users">https://auth0.com/docs/api#!#get–api-users</a></p>
1527
-
1528
- <p><a href="https://auth0.com/docs/api#!#get–api-users-search–criteria-" target="_parent" title="https://auth0.com/docs/api#!#get–api-users-search–criteria-">https://auth0.com/docs/api#!#get–api-users-search–criteria-</a></p>
1529
-
1530
-
1531
- </div>
1532
- </div>
1533
- <div class="tags">
1534
-
1535
-
1536
- </div><table class="source_code">
1537
- <tr>
1538
- <td>
1539
- <pre class="lines">
1540
-
1541
-
1542
- 9
1543
- 10
1544
- 11
1545
- 12
1546
- 13</pre>
1547
- </td>
1548
- <td>
1549
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 9</span>
1550
-
1551
- <span class='kw'>def</span> <span class='id identifier rubyid_users'>users</span><span class='lparen'>(</span><span class='id identifier rubyid_search'>search</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
1552
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users</span><span class='tstring_end'>&quot;</span></span>
1553
- <span class='id identifier rubyid_path'>path</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>?search=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_search'>search</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_search'>search</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
1554
- <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
1555
- <span class='kw'>end</span></pre>
1556
- </td>
1557
- </tr>
1558
- </table>
1559
- </div>
1560
-
1561
- <div class="method_details ">
1562
- <h3 class="signature " id="verification_ticket-instance_method">
1563
-
1564
- - (<tt>Object</tt>) <strong>verification_ticket</strong>(user_id, result_url = nil)
1565
-
1566
-
1567
-
1568
-
1569
-
1570
- </h3><div class="docstring">
1571
- <div class="discussion">
1572
-
1573
- <p><a href="https://auth0.com/docs/api#!#post–api-users–user_id–verification_ticket" target="_parent" title="https://auth0.com/docs/api#!#post–api-users–user_id–verification_ticket">https://auth0.com/docs/api#!#post–api-users–user_id–verification_ticket</a></p>
1574
-
1575
-
1576
- </div>
1577
- </div>
1578
- <div class="tags">
1579
-
1580
-
1581
- </div><table class="source_code">
1582
- <tr>
1583
- <td>
1584
- <pre class="lines">
1585
-
1586
-
1587
- 82
1588
- 83
1589
- 84
1590
- 85
1591
- 86</pre>
1592
- </td>
1593
- <td>
1594
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v1/users.rb', line 82</span>
1595
-
1596
- <span class='kw'>def</span> <span class='id identifier rubyid_verification_ticket'>verification_ticket</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_result_url'>result_url</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
1597
- <span class='id identifier rubyid_request_params'>request_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>resultUrl</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_result_url'>result_url</span><span class='rbrace'>}</span>
1598
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/api/users/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user_id'>user_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/verification_ticket</span><span class='tstring_end'>&quot;</span></span>
1599
- <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_request_params'>request_params</span><span class='rparen'>)</span>
1600
- <span class='kw'>end</span></pre>
1601
- </td>
1602
- </tr>
1603
- </table>
1604
- </div>
1605
-
1606
- </div>
1607
-
1608
- </div>
1609
-
1610
- <div id="footer">
1611
- Generated on Mon Feb 23 01:12:53 2015 by
1612
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1613
- 0.8.7.6 (ruby-2.0.0).
1614
- </div>
1615
-
1616
- </body>
1617
- </html>