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,652 +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::V2::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/V2/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="../V2.html" title="Auth0::Api::V2 (module)">V2</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::V2::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="../V2.html" title="Auth0::Api::V2 (module)">Auth0::Api::V2</a></span></dd>
82
-
83
-
84
-
85
- <dt class="r2 last">Defined in:</dt>
86
- <dd class="r2 last">lib/auth0/api/v2/users.rb</dd>
87
-
88
- </dl>
89
- <div class="clear"></div>
90
-
91
-
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
- <h2>
100
- Instance Method Summary
101
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
102
- </h2>
103
-
104
- <ul class="summary">
105
-
106
- <li class="public ">
107
- <span class="summary_signature">
108
-
109
- <a href="#create_user-instance_method" title="#create_user (instance method)">- (Object) <strong>create_user</strong>(name, options = {}) </a>
110
-
111
-
112
-
113
- </span>
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
- <span class="summary_desc"><div class='inline'>
124
- <p><a
125
- href="https://auth0.com/docs/apiv2#!/users/post_users">auth0.com/docs/apiv2#!/users/post_users</a>.</p>
126
- </div></span>
127
-
128
- </li>
129
-
130
-
131
- <li class="public ">
132
- <span class="summary_signature">
133
-
134
- <a href="#delete_user-instance_method" title="#delete_user (instance method)">- (Object) <strong>delete_user</strong>(user_id) </a>
135
-
136
-
137
-
138
- </span>
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
- <span class="summary_desc"><div class='inline'>
149
- <p><a
150
- href="https://auth0.com/docs/apiv2#!/users/delete_users_by_id">auth0.com/docs/apiv2#!/users/delete_users_by_id</a>.</p>
151
- </div></span>
152
-
153
- </li>
154
-
155
-
156
- <li class="public ">
157
- <span class="summary_signature">
158
-
159
- <a href="#delete_user_provider-instance_method" title="#delete_user_provider (instance method)">- (Object) <strong>delete_user_provider</strong>(user_id, provider_name) </a>
160
-
161
-
162
-
163
- </span>
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
- <span class="summary_desc"><div class='inline'>
174
- <p><a
175
- href="https://auth0.com/docs/apiv2#!/users/delete_multifactor_by_provider">auth0.com/docs/apiv2#!/users/delete_multifactor_by_provider</a>.</p>
176
- </div></span>
177
-
178
- </li>
179
-
180
-
181
- <li class="public ">
182
- <span class="summary_signature">
183
-
184
- <a href="#delete_users-instance_method" title="#delete_users (instance method)">- (Object) <strong>delete_users</strong> </a>
185
-
186
-
187
-
188
- </span>
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
- <span class="summary_desc"><div class='inline'>
199
- <p><a
200
- href="https://auth0.com/docs/apiv2#!/users/delete_users">auth0.com/docs/apiv2#!/users/delete_users</a>.</p>
201
- </div></span>
202
-
203
- </li>
204
-
205
-
206
- <li class="public ">
207
- <span class="summary_signature">
208
-
209
- <a href="#patch_user-instance_method" title="#patch_user (instance method)">- (Object) <strong>patch_user</strong>(user_id, options) </a>
210
-
211
-
212
-
213
- </span>
214
-
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
-
223
- <span class="summary_desc"><div class='inline'>
224
- <p><a
225
- href="https://auth0.com/docs/apiv2#!/users/patch_users_by_id">auth0.com/docs/apiv2#!/users/patch_users_by_id</a>.</p>
226
- </div></span>
227
-
228
- </li>
229
-
230
-
231
- <li class="public ">
232
- <span class="summary_signature">
233
-
234
- <a href="#user-instance_method" title="#user (instance method)">- (Object) <strong>user</strong>(user_id, fields: nil, exclude_fields: nil) </a>
235
-
236
-
237
-
238
- </span>
239
-
240
-
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
- <span class="summary_desc"><div class='inline'>
249
- <p><a
250
- href="https://auth0.com/docs/apiv2#!/users/get_users_by_id">auth0.com/docs/apiv2#!/users/get_users_by_id</a>.</p>
251
- </div></span>
252
-
253
- </li>
254
-
255
-
256
- <li class="public ">
257
- <span class="summary_signature">
258
-
259
- <a href="#users-instance_method" title="#users (instance method)">- (Object) <strong>users</strong>(per_page: nil, page: nil, include_totals: nil, sort: nil, connection: nil, fields: nil, exclude_fields: nil, q: nil) </a>
260
-
261
-
262
-
263
- (also: #get_users)
264
-
265
- </span>
266
-
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
- <span class="summary_desc"><div class='inline'>
276
- <p><a
277
- href="https://auth0.com/docs/apiv2#!/users/get_users">auth0.com/docs/apiv2#!/users/get_users</a>.</p>
278
- </div></span>
279
-
280
- </li>
281
-
282
-
283
- </ul>
284
-
285
-
286
-
287
-
288
- <div id="instance_method_details" class="method_details_list">
289
- <h2>Instance Method Details</h2>
290
-
291
-
292
- <div class="method_details first">
293
- <h3 class="signature first" id="create_user-instance_method">
294
-
295
- - (<tt>Object</tt>) <strong>create_user</strong>(name, options = {})
296
-
297
-
298
-
299
-
300
-
301
- </h3><div class="docstring">
302
- <div class="discussion">
303
-
304
- <p><a
305
- href="https://auth0.com/docs/apiv2#!/users/post_users">auth0.com/docs/apiv2#!/users/post_users</a></p>
306
-
307
-
308
- </div>
309
- </div>
310
- <div class="tags">
311
-
312
-
313
- </div><table class="source_code">
314
- <tr>
315
- <td>
316
- <pre class="lines">
317
-
318
-
319
- 21
320
- 22
321
- 23
322
- 24
323
- 25</pre>
324
- </td>
325
- <td>
326
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v2/users.rb', line 21</span>
327
-
328
- <span class='kw'>def</span> <span class='id identifier rubyid_create_user'>create_user</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
329
- <span class='id identifier rubyid_request_params'>request_params</span> <span class='op'>=</span> <span class='const'>Hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span><span class='op'>|</span><span class='lparen'>(</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='rparen'>)</span><span class='op'>|</span> <span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='rbracket'>]</span>
330
- <span class='id identifier rubyid_request_params'>request_params</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
331
- <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>
332
- <span class='kw'>end</span></pre>
333
- </td>
334
- </tr>
335
- </table>
336
- </div>
337
-
338
- <div class="method_details ">
339
- <h3 class="signature " id="delete_user-instance_method">
340
-
341
- - (<tt>Object</tt>) <strong>delete_user</strong>(user_id)
342
-
343
-
344
-
345
-
346
-
347
- </h3><div class="docstring">
348
- <div class="discussion">
349
-
350
- <p><a
351
- href="https://auth0.com/docs/apiv2#!/users/delete_users_by_id">auth0.com/docs/apiv2#!/users/delete_users_by_id</a></p>
352
-
353
-
354
- </div>
355
- </div>
356
- <div class="tags">
357
-
358
- <p class="tag_title">Raises:</p>
359
- <ul class="raise">
360
-
361
- <li>
362
-
363
-
364
- <span class='type'>(<tt><span class='object_link'><a href="../../UserIdIsBlank.html" title="Auth0::UserIdIsBlank (class)">Auth0::UserIdIsBlank</a></span></tt>)</span>
365
-
366
-
367
-
368
- </li>
369
-
370
- </ul>
371
-
372
- </div><table class="source_code">
373
- <tr>
374
- <td>
375
- <pre class="lines">
376
-
377
-
378
- 42
379
- 43
380
- 44
381
- 45
382
- 46</pre>
383
- </td>
384
- <td>
385
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v2/users.rb', line 42</span>
386
-
387
- <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>
388
- <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>
389
- <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/v2/users/</span><span class='tstring_end'>&quot;</span></span> <span class='op'>+</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>
390
- <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
391
- <span class='kw'>end</span></pre>
392
- </td>
393
- </tr>
394
- </table>
395
- </div>
396
-
397
- <div class="method_details ">
398
- <h3 class="signature " id="delete_user_provider-instance_method">
399
-
400
- - (<tt>Object</tt>) <strong>delete_user_provider</strong>(user_id, provider_name)
401
-
402
-
403
-
404
-
405
-
406
- </h3><div class="docstring">
407
- <div class="discussion">
408
-
409
- <p><a
410
- href="https://auth0.com/docs/apiv2#!/users/delete_multifactor_by_provider">auth0.com/docs/apiv2#!/users/delete_multifactor_by_provider</a></p>
411
-
412
-
413
- </div>
414
- </div>
415
- <div class="tags">
416
-
417
-
418
- </div><table class="source_code">
419
- <tr>
420
- <td>
421
- <pre class="lines">
422
-
423
-
424
- 56
425
- 57
426
- 58
427
- 59</pre>
428
- </td>
429
- <td>
430
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v2/users.rb', line 56</span>
431
-
432
- <span class='kw'>def</span> <span class='id identifier rubyid_delete_user_provider'>delete_user_provider</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_provider_name'>provider_name</span><span class='rparen'>)</span>
433
- <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/v2/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'>/multifactor/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_provider_name'>provider_name</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
434
- <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
435
- <span class='kw'>end</span></pre>
436
- </td>
437
- </tr>
438
- </table>
439
- </div>
440
-
441
- <div class="method_details ">
442
- <h3 class="signature " id="delete_users-instance_method">
443
-
444
- - (<tt>Object</tt>) <strong>delete_users</strong>
445
-
446
-
447
-
448
-
449
-
450
- </h3><div class="docstring">
451
- <div class="discussion">
452
-
453
- <p><a
454
- href="https://auth0.com/docs/apiv2#!/users/delete_users">auth0.com/docs/apiv2#!/users/delete_users</a></p>
455
-
456
-
457
- </div>
458
- </div>
459
- <div class="tags">
460
-
461
-
462
- </div><table class="source_code">
463
- <tr>
464
- <td>
465
- <pre class="lines">
466
-
467
-
468
- 28
469
- 29
470
- 30</pre>
471
- </td>
472
- <td>
473
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v2/users.rb', line 28</span>
474
-
475
- <span class='kw'>def</span> <span class='id identifier rubyid_delete_users'>delete_users</span>
476
- <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
477
- <span class='kw'>end</span></pre>
478
- </td>
479
- </tr>
480
- </table>
481
- </div>
482
-
483
- <div class="method_details ">
484
- <h3 class="signature " id="patch_user-instance_method">
485
-
486
- - (<tt>Object</tt>) <strong>patch_user</strong>(user_id, options)
487
-
488
-
489
-
490
-
491
-
492
- </h3><div class="docstring">
493
- <div class="discussion">
494
-
495
- <p><a
496
- href="https://auth0.com/docs/apiv2#!/users/patch_users_by_id">auth0.com/docs/apiv2#!/users/patch_users_by_id</a></p>
497
-
498
-
499
- </div>
500
- </div>
501
- <div class="tags">
502
-
503
-
504
- </div><table class="source_code">
505
- <tr>
506
- <td>
507
- <pre class="lines">
508
-
509
-
510
- 50
511
- 51
512
- 52
513
- 53</pre>
514
- </td>
515
- <td>
516
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v2/users.rb', line 50</span>
517
-
518
- <span class='kw'>def</span> <span class='id identifier rubyid_patch_user'>patch_user</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
519
- <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/v2/users/</span><span class='tstring_end'>&quot;</span></span> <span class='op'>+</span> <span class='id identifier rubyid_user_id'>user_id</span>
520
- <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_options'>options</span><span class='rparen'>)</span>
521
- <span class='kw'>end</span></pre>
522
- </td>
523
- </tr>
524
- </table>
525
- </div>
526
-
527
- <div class="method_details ">
528
- <h3 class="signature " id="user-instance_method">
529
-
530
- - (<tt>Object</tt>) <strong>user</strong>(user_id, fields: nil, exclude_fields: nil)
531
-
532
-
533
-
534
-
535
-
536
- </h3><div class="docstring">
537
- <div class="discussion">
538
-
539
- <p><a
540
- href="https://auth0.com/docs/apiv2#!/users/get_users_by_id">auth0.com/docs/apiv2#!/users/get_users_by_id</a></p>
541
-
542
-
543
- </div>
544
- </div>
545
- <div class="tags">
546
-
547
-
548
- </div><table class="source_code">
549
- <tr>
550
- <td>
551
- <pre class="lines">
552
-
553
-
554
- 33
555
- 34
556
- 35
557
- 36
558
- 37
559
- 38
560
- 39</pre>
561
- </td>
562
- <td>
563
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v2/users.rb', line 33</span>
564
-
565
- <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='comma'>,</span> <span class='label'>fields:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>exclude_fields:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
566
- <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/v2/users/</span><span class='tstring_end'>&quot;</span></span> <span class='op'>+</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>
567
- <span class='id identifier rubyid_request_params'>request_params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>fields:</span> <span class='id identifier rubyid_fields'>fields</span><span class='comma'>,</span>
568
- <span class='label'>exclude_fields:</span> <span class='id identifier rubyid_exclude_fields'>exclude_fields</span>
569
- <span class='rbrace'>}</span>
570
- <span class='id identifier rubyid_get'>get</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>
571
- <span class='kw'>end</span></pre>
572
- </td>
573
- </tr>
574
- </table>
575
- </div>
576
-
577
- <div class="method_details ">
578
- <h3 class="signature " id="users-instance_method">
579
-
580
- - (<tt>Object</tt>) <strong>users</strong>(per_page: nil, page: nil, include_totals: nil, sort: nil, connection: nil, fields: nil, exclude_fields: nil, q: nil)
581
-
582
-
583
-
584
- <span class="aliases">Also known as:
585
- <span class="names"><span id='get_users-instance_method'>get_users</span></span>
586
- </span>
587
-
588
-
589
-
590
- </h3><div class="docstring">
591
- <div class="discussion">
592
-
593
- <p><a
594
- href="https://auth0.com/docs/apiv2#!/users/get_users">auth0.com/docs/apiv2#!/users/get_users</a></p>
595
-
596
-
597
- </div>
598
- </div>
599
- <div class="tags">
600
-
601
-
602
- </div><table class="source_code">
603
- <tr>
604
- <td>
605
- <pre class="lines">
606
-
607
-
608
- 6
609
- 7
610
- 8
611
- 9
612
- 10
613
- 11
614
- 12
615
- 13
616
- 14
617
- 15
618
- 16
619
- 17</pre>
620
- </td>
621
- <td>
622
- <pre class="code"><span class="info file"># File 'lib/auth0/api/v2/users.rb', line 6</span>
623
-
624
- <span class='kw'>def</span> <span class='id identifier rubyid_users'>users</span><span class='lparen'>(</span> <span class='label'>per_page:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>page:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>include_totals:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>sort:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>connection:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>fields:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>exclude_fields:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>q:</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
625
- <span class='id identifier rubyid_request_params'>request_params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>per_page:</span> <span class='id identifier rubyid_per_page'>per_page</span><span class='comma'>,</span>
626
- <span class='label'>page:</span> <span class='id identifier rubyid_page'>page</span><span class='comma'>,</span>
627
- <span class='label'>include_totals:</span> <span class='id identifier rubyid_include_totals'>include_totals</span><span class='comma'>,</span>
628
- <span class='label'>sort:</span> <span class='id identifier rubyid_sort'>sort</span><span class='comma'>,</span>
629
- <span class='label'>connection:</span> <span class='id identifier rubyid_connection'>connection</span><span class='comma'>,</span>
630
- <span class='label'>fields:</span> <span class='id identifier rubyid_fields'>fields</span><span class='comma'>,</span>
631
- <span class='label'>exclude_fields:</span> <span class='id identifier rubyid_exclude_fields'>exclude_fields</span><span class='comma'>,</span>
632
- <span class='label'>q:</span> <span class='id identifier rubyid_q'>q</span>
633
- <span class='rbrace'>}</span>
634
- <span class='id identifier rubyid_get'>get</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>
635
- <span class='kw'>end</span></pre>
636
- </td>
637
- </tr>
638
- </table>
639
- </div>
640
-
641
- </div>
642
-
643
- </div>
644
-
645
- <div id="footer">
646
- Generated on Mon Feb 23 01:12:53 2015 by
647
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
648
- 0.8.7.6 (ruby-2.0.0).
649
- </div>
650
-
651
- </body>
652
- </html>