<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: Auth0::Api::V2::Users
— Documentation by YARD 0.8.7.6
</title>
<link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../../../';
framesUrl = "../../../frames.html#!Auth0/Api/V2/Users.html";
</script>
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (U)</a> »
<span class='title'><span class='object_link'><a href="../../../Auth0.html" title="Auth0 (module)">Auth0</a></span></span> » <span class='title'><span class='object_link'><a href="../../Api.html" title="Auth0::Api (module)">Api</a></span></span> » <span class='title'><span class='object_link'><a href="../V2.html" title="Auth0::Api::V2 (module)">V2</a></span></span>
»
<span class="title">Users</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../../../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../../../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: Auth0::Api::V2::Users
</h1>
<dl class="box">
<dt class="r1">Included in:</dt>
<dd class="r1"><span class='object_link'><a href="../V2.html" title="Auth0::Api::V2 (module)">Auth0::Api::V2</a></span></dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/auth0/api/v2/users.rb</dd>
</dl>
<div class="clear"></div>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#create_user-instance_method" title="#create_user (instance method)">- (Object) <strong>create_user</strong>(name, options = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p><a
href="https://auth0.com/docs/apiv2#!/users/post_users">auth0.com/docs/apiv2#!/users/post_users</a>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_user-instance_method" title="#delete_user (instance method)">- (Object) <strong>delete_user</strong>(user_id) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p><a
href="https://auth0.com/docs/apiv2#!/users/delete_users_by_id">auth0.com/docs/apiv2#!/users/delete_users_by_id</a>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_user_provider-instance_method" title="#delete_user_provider (instance method)">- (Object) <strong>delete_user_provider</strong>(user_id, provider_name) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p><a
href="https://auth0.com/docs/apiv2#!/users/delete_multifactor_by_provider">auth0.com/docs/apiv2#!/users/delete_multifactor_by_provider</a>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_users-instance_method" title="#delete_users (instance method)">- (Object) <strong>delete_users</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p><a
href="https://auth0.com/docs/apiv2#!/users/delete_users">auth0.com/docs/apiv2#!/users/delete_users</a>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#patch_user-instance_method" title="#patch_user (instance method)">- (Object) <strong>patch_user</strong>(user_id, options) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p><a
href="https://auth0.com/docs/apiv2#!/users/patch_users_by_id">auth0.com/docs/apiv2#!/users/patch_users_by_id</a>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#user-instance_method" title="#user (instance method)">- (Object) <strong>user</strong>(user_id, fields: nil, exclude_fields: nil) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p><a
href="https://auth0.com/docs/apiv2#!/users/get_users_by_id">auth0.com/docs/apiv2#!/users/get_users_by_id</a>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<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>
(also: #get_users)
</span>
<span class="summary_desc"><div class='inline'>
<p><a
href="https://auth0.com/docs/apiv2#!/users/get_users">auth0.com/docs/apiv2#!/users/get_users</a>.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="create_user-instance_method">
- (<tt>Object</tt>) <strong>create_user</strong>(name, options = {})
</h3><div class="docstring">
<div class="discussion">
<p><a
href="https://auth0.com/docs/apiv2#!/users/post_users">auth0.com/docs/apiv2#!/users/post_users</a></p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
21
22
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/auth0/api/v2/users.rb', line 21</span>
<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>
<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>
<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>
<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>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete_user-instance_method">
- (<tt>Object</tt>) <strong>delete_user</strong>(user_id)
</h3><div class="docstring">
<div class="discussion">
<p><a
href="https://auth0.com/docs/apiv2#!/users/delete_users_by_id">auth0.com/docs/apiv2#!/users/delete_users_by_id</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../../UserIdIsBlank.html" title="Auth0::UserIdIsBlank (class)">Auth0::UserIdIsBlank</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
42
43
44
45
46</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/auth0/api/v2/users.rb', line 42</span>
<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>
<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'>"</span><span class='tstring_content'>if you want to remove all users user delete_users method</span><span class='tstring_end'>"</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>
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/api/v2/users/</span><span class='tstring_end'>"</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>
<span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete_user_provider-instance_method">
- (<tt>Object</tt>) <strong>delete_user_provider</strong>(user_id, provider_name)
</h3><div class="docstring">
<div class="discussion">
<p><a
href="https://auth0.com/docs/apiv2#!/users/delete_multifactor_by_provider">auth0.com/docs/apiv2#!/users/delete_multifactor_by_provider</a></p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
56
57
58
59</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/auth0/api/v2/users.rb', line 56</span>
<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>
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</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'>"</span></span>
<span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete_users-instance_method">
- (<tt>Object</tt>) <strong>delete_users</strong>
</h3><div class="docstring">
<div class="discussion">
<p><a
href="https://auth0.com/docs/apiv2#!/users/delete_users">auth0.com/docs/apiv2#!/users/delete_users</a></p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/auth0/api/v2/users.rb', line 28</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_users'>delete_users</span>
<span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="patch_user-instance_method">
- (<tt>Object</tt>) <strong>patch_user</strong>(user_id, options)
</h3><div class="docstring">
<div class="discussion">
<p><a
href="https://auth0.com/docs/apiv2#!/users/patch_users_by_id">auth0.com/docs/apiv2#!/users/patch_users_by_id</a></p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
50
51
52
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/auth0/api/v2/users.rb', line 50</span>
<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>
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/api/v2/users/</span><span class='tstring_end'>"</span></span> <span class='op'>+</span> <span class='id identifier rubyid_user_id'>user_id</span>
<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>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="user-instance_method">
- (<tt>Object</tt>) <strong>user</strong>(user_id, fields: nil, exclude_fields: nil)
</h3><div class="docstring">
<div class="discussion">
<p><a
href="https://auth0.com/docs/apiv2#!/users/get_users_by_id">auth0.com/docs/apiv2#!/users/get_users_by_id</a></p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
33
34
35
36
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/auth0/api/v2/users.rb', line 33</span>
<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>
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/api/v2/users/</span><span class='tstring_end'>"</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>
<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>
<span class='label'>exclude_fields:</span> <span class='id identifier rubyid_exclude_fields'>exclude_fields</span>
<span class='rbrace'>}</span>
<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>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="users-instance_method">
- (<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)
<span class="aliases">Also known as:
<span class="names"><span id='get_users-instance_method'>get_users</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p><a
href="https://auth0.com/docs/apiv2#!/users/get_users">auth0.com/docs/apiv2#!/users/get_users</a></p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
6
7
8
9
10
11
12
13
14
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/auth0/api/v2/users.rb', line 6</span>
<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>
<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>
<span class='label'>page:</span> <span class='id identifier rubyid_page'>page</span><span class='comma'>,</span>
<span class='label'>include_totals:</span> <span class='id identifier rubyid_include_totals'>include_totals</span><span class='comma'>,</span>
<span class='label'>sort:</span> <span class='id identifier rubyid_sort'>sort</span><span class='comma'>,</span>
<span class='label'>connection:</span> <span class='id identifier rubyid_connection'>connection</span><span class='comma'>,</span>
<span class='label'>fields:</span> <span class='id identifier rubyid_fields'>fields</span><span class='comma'>,</span>
<span class='label'>exclude_fields:</span> <span class='id identifier rubyid_exclude_fields'>exclude_fields</span><span class='comma'>,</span>
<span class='label'>q:</span> <span class='id identifier rubyid_q'>q</span>
<span class='rbrace'>}</span>
<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>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Feb 23 01:12:53 2015 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.0.0).
</div>
</body>
</html>