auth0-ruby 0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.bundle/config +2 -0
- data/.gitignore +8 -0
- data/.rspec +2 -0
- data/Gemfile +4 -0
- data/Gemfile.lock +68 -0
- data/README.md +27 -0
- data/Rakefile +9 -0
- data/auth0.gemspec +29 -0
- data/doc/Auth0.html +153 -0
- data/doc/Auth0/Api.html +128 -0
- data/doc/Auth0/Api/AuthenticationEndpoints.html +596 -0
- data/doc/Auth0/Api/V1.html +192 -0
- data/doc/Auth0/Api/V1/Clients.html +440 -0
- data/doc/Auth0/Api/V1/Connections.html +506 -0
- data/doc/Auth0/Api/V1/Logs.html +366 -0
- data/doc/Auth0/Api/V1/Rules.html +439 -0
- data/doc/Auth0/Api/V1/Users.html +1617 -0
- data/doc/Auth0/BadRequest.html +142 -0
- data/doc/Auth0/Client.html +236 -0
- data/doc/Auth0/Exception.html +140 -0
- data/doc/Auth0/Mixins.html +225 -0
- data/doc/Auth0/Mixins/HTTPartyProxy.html +121 -0
- data/doc/Auth0/Mixins/Initializer.html +298 -0
- data/doc/Auth0/NotFound.html +143 -0
- data/doc/Auth0/ServerError.html +142 -0
- data/doc/Auth0/Unauthorized.html +143 -0
- data/doc/Auth0/Unsupported.html +142 -0
- data/doc/Auth0/UserIdIsBlank.html +143 -0
- data/doc/Auth0Client.html +235 -0
- data/doc/_index.html +347 -0
- data/doc/class_list.html +58 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +339 -0
- data/doc/file.README.html +103 -0
- data/doc/file_list.html +60 -0
- data/doc/frames.html +26 -0
- data/doc/index.html +103 -0
- data/doc/js/app.js +219 -0
- data/doc/js/full_list.js +181 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +327 -0
- data/doc/top-level-namespace.html +114 -0
- data/lib/auth0.rb +8 -0
- data/lib/auth0/api/authentication_endpoints.rb +71 -0
- data/lib/auth0/api/v1.rb +19 -0
- data/lib/auth0/api/v1/clients.rb +48 -0
- data/lib/auth0/api/v1/connections.rb +51 -0
- data/lib/auth0/api/v1/logs.rb +41 -0
- data/lib/auth0/api/v1/rules.rb +44 -0
- data/lib/auth0/api/v1/users.rb +163 -0
- data/lib/auth0/client.rb +7 -0
- data/lib/auth0/exception.rb +18 -0
- data/lib/auth0/mixins.rb +13 -0
- data/lib/auth0/mixins/httparty_proxy.rb +29 -0
- data/lib/auth0/mixins/initializer.rb +25 -0
- data/lib/auth0/version.rb +4 -0
- data/lib/auth0_client.rb +3 -0
- data/spec/lib/auth0/api/authentication_endpoints_spec.rb +56 -0
- data/spec/lib/auth0/api/v1/clients_spec.rb +62 -0
- data/spec/lib/auth0/api/v1/connections_spec.rb +62 -0
- data/spec/lib/auth0/api/v1/logs_spec.rb +46 -0
- data/spec/lib/auth0/api/v1/rules_spec.rb +40 -0
- data/spec/lib/auth0/api/v1/users_spec.rb +215 -0
- data/spec/lib/auth0/client_spec.rb +19 -0
- data/spec/lib/auth0/mixins/httparty_proxy_spec.rb +60 -0
- data/spec/lib/auth0_client_spec.rb +8 -0
- data/spec/spec_helper.rb +18 -0
- data/spec/support/dummy_class.rb +7 -0
- data/spec/support/dummy_class_for_proxy.rb +4 -0
- data/spec/support/stub_response.rb +2 -0
- metadata +253 -0
@@ -0,0 +1,192 @@
|
|
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
|
8
|
+
|
9
|
+
— 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.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 (V)</a> »
|
35
|
+
<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>
|
36
|
+
»
|
37
|
+
<span class="title">V1</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
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
</h1>
|
71
|
+
|
72
|
+
<dl class="box">
|
73
|
+
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
|
78
|
+
<dt class="r1">Includes:</dt>
|
79
|
+
<dd class="r1"><span class='object_link'><a href="V1/Clients.html" title="Auth0::Api::V1::Clients (module)">Clients</a></span>, <span class='object_link'><a href="V1/Connections.html" title="Auth0::Api::V1::Connections (module)">Connections</a></span>, <span class='object_link'><a href="V1/Logs.html" title="Auth0::Api::V1::Logs (module)">Logs</a></span>, <span class='object_link'><a href="V1/Rules.html" title="Auth0::Api::V1::Rules (module)">Rules</a></span>, <span class='object_link'><a href="V1/Users.html" title="Auth0::Api::V1::Users (module)">Users</a></span></dd>
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
|
84
|
+
<dt class="r2">Included in:</dt>
|
85
|
+
<dd class="r2"><span class='object_link'><a href="../Mixins.html" title="Auth0::Mixins (module)">Mixins</a></span></dd>
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
<dt class="r1 last">Defined in:</dt>
|
90
|
+
<dd class="r1 last">lib/auth0/api/v1.rb<span class="defines">,<br />
|
91
|
+
lib/auth0/api/v1/logs.rb,<br /> lib/auth0/api/v1/users.rb,<br /> lib/auth0/api/v1/rules.rb,<br /> lib/auth0/api/v1/clients.rb,<br /> lib/auth0/api/v1/connections.rb</span>
|
92
|
+
</dd>
|
93
|
+
|
94
|
+
</dl>
|
95
|
+
<div class="clear"></div>
|
96
|
+
|
97
|
+
<h2>Overview</h2><div class="docstring">
|
98
|
+
<div class="discussion">
|
99
|
+
|
100
|
+
<p><a href="https://auth0.com/docs/api" target="_parent" title="https://auth0.com/docs/api">https://auth0.com/docs/api</a> Describing current functionality of Auth0 API
|
101
|
+
V1</p>
|
102
|
+
|
103
|
+
|
104
|
+
</div>
|
105
|
+
</div>
|
106
|
+
<div class="tags">
|
107
|
+
|
108
|
+
|
109
|
+
</div><h2>Defined Under Namespace</h2>
|
110
|
+
<p class="children">
|
111
|
+
|
112
|
+
|
113
|
+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="V1/Clients.html" title="Auth0::Api::V1::Clients (module)">Clients</a></span>, <span class='object_link'><a href="V1/Connections.html" title="Auth0::Api::V1::Connections (module)">Connections</a></span>, <span class='object_link'><a href="V1/Logs.html" title="Auth0::Api::V1::Logs (module)">Logs</a></span>, <span class='object_link'><a href="V1/Rules.html" title="Auth0::Api::V1::Rules (module)">Rules</a></span>, <span class='object_link'><a href="V1/Users.html" title="Auth0::Api::V1::Users (module)">Users</a></span>
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
|
118
|
+
</p>
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
<h2>Method Summary</h2>
|
134
|
+
|
135
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="V1/Logs.html" title="Auth0::Api::V1::Logs (module)">Logs</a></span></h3>
|
136
|
+
<p class="inherited"><span class='object_link'><a href="V1/Logs.html#log-instance_method" title="Auth0::Api::V1::Logs#log (method)">#log</a></span>, <span class='object_link'><a href="V1/Logs.html#logs-instance_method" title="Auth0::Api::V1::Logs#logs (method)">#logs</a></span>, <span class='object_link'><a href="V1/Logs.html#user_logs-instance_method" title="Auth0::Api::V1::Logs#user_logs (method)">#user_logs</a></span></p>
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="V1/Rules.html" title="Auth0::Api::V1::Rules (module)">Rules</a></span></h3>
|
147
|
+
<p class="inherited"><span class='object_link'><a href="V1/Rules.html#create_rule-instance_method" title="Auth0::Api::V1::Rules#create_rule (method)">#create_rule</a></span>, <span class='object_link'><a href="V1/Rules.html#delete_rule-instance_method" title="Auth0::Api::V1::Rules#delete_rule (method)">#delete_rule</a></span>, <span class='object_link'><a href="V1/Rules.html#rules-instance_method" title="Auth0::Api::V1::Rules#rules (method)">#rules</a></span>, <span class='object_link'><a href="V1/Rules.html#update_rule-instance_method" title="Auth0::Api::V1::Rules#update_rule (method)">#update_rule</a></span></p>
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="V1/Clients.html" title="Auth0::Api::V1::Clients (module)">Clients</a></span></h3>
|
158
|
+
<p class="inherited"><span class='object_link'><a href="V1/Clients.html#clients-instance_method" title="Auth0::Api::V1::Clients#clients (method)">#clients</a></span>, <span class='object_link'><a href="V1/Clients.html#create_client-instance_method" title="Auth0::Api::V1::Clients#create_client (method)">#create_client</a></span>, <span class='object_link'><a href="V1/Clients.html#patch_client-instance_method" title="Auth0::Api::V1::Clients#patch_client (method)">#patch_client</a></span>, <span class='object_link'><a href="V1/Clients.html#update_client-instance_method" title="Auth0::Api::V1::Clients#update_client (method)">#update_client</a></span></p>
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="V1/Connections.html" title="Auth0::Api::V1::Connections (module)">Connections</a></span></h3>
|
169
|
+
<p class="inherited"><span class='object_link'><a href="V1/Connections.html#connection-instance_method" title="Auth0::Api::V1::Connections#connection (method)">#connection</a></span>, <span class='object_link'><a href="V1/Connections.html#connections-instance_method" title="Auth0::Api::V1::Connections#connections (method)">#connections</a></span>, <span class='object_link'><a href="V1/Connections.html#create_connection-instance_method" title="Auth0::Api::V1::Connections#create_connection (method)">#create_connection</a></span>, <span class='object_link'><a href="V1/Connections.html#delete_connection-instance_method" title="Auth0::Api::V1::Connections#delete_connection (method)">#delete_connection</a></span>, <span class='object_link'><a href="V1/Connections.html#update_connection-instance_method" title="Auth0::Api::V1::Connections#update_connection (method)">#update_connection</a></span></p>
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="V1/Users.html" title="Auth0::Api::V1::Users (module)">Users</a></span></h3>
|
180
|
+
<p class="inherited"><span class='object_link'><a href="V1/Users.html#change_password_ticket-instance_method" title="Auth0::Api::V1::Users#change_password_ticket (method)">#change_password_ticket</a></span>, <span class='object_link'><a href="V1/Users.html#client_users-instance_method" title="Auth0::Api::V1::Users#client_users (method)">#client_users</a></span>, <span class='object_link'><a href="V1/Users.html#connection_users-instance_method" title="Auth0::Api::V1::Users#connection_users (method)">#connection_users</a></span>, <span class='object_link'><a href="V1/Users.html#create_public_key-instance_method" title="Auth0::Api::V1::Users#create_public_key (method)">#create_public_key</a></span>, <span class='object_link'><a href="V1/Users.html#create_user-instance_method" title="Auth0::Api::V1::Users#create_user (method)">#create_user</a></span>, <span class='object_link'><a href="V1/Users.html#delete_user-instance_method" title="Auth0::Api::V1::Users#delete_user (method)">#delete_user</a></span>, <span class='object_link'><a href="V1/Users.html#delete_users-instance_method" title="Auth0::Api::V1::Users#delete_users (method)">#delete_users</a></span>, <span class='object_link'><a href="V1/Users.html#enterpriseconnections_users-instance_method" title="Auth0::Api::V1::Users#enterpriseconnections_users (method)">#enterpriseconnections_users</a></span>, <span class='object_link'><a href="V1/Users.html#patch_user_metadata-instance_method" title="Auth0::Api::V1::Users#patch_user_metadata (method)">#patch_user_metadata</a></span>, <span class='object_link'><a href="V1/Users.html#revoke_user_device_public_key-instance_method" title="Auth0::Api::V1::Users#revoke_user_device_public_key (method)">#revoke_user_device_public_key</a></span>, <span class='object_link'><a href="V1/Users.html#revoke_user_refresh_token-instance_method" title="Auth0::Api::V1::Users#revoke_user_refresh_token (method)">#revoke_user_refresh_token</a></span>, <span class='object_link'><a href="V1/Users.html#send_verification_email-instance_method" title="Auth0::Api::V1::Users#send_verification_email (method)">#send_verification_email</a></span>, <span class='object_link'><a href="V1/Users.html#socialconnections_users-instance_method" title="Auth0::Api::V1::Users#socialconnections_users (method)">#socialconnections_users</a></span>, <span class='object_link'><a href="V1/Users.html#update_user_email-instance_method" title="Auth0::Api::V1::Users#update_user_email (method)">#update_user_email</a></span>, <span class='object_link'><a href="V1/Users.html#update_user_metadata-instance_method" title="Auth0::Api::V1::Users#update_user_metadata (method)">#update_user_metadata</a></span>, <span class='object_link'><a href="V1/Users.html#update_user_password-instance_method" title="Auth0::Api::V1::Users#update_user_password (method)">#update_user_password</a></span>, <span class='object_link'><a href="V1/Users.html#update_user_password_using_email-instance_method" title="Auth0::Api::V1::Users#update_user_password_using_email (method)">#update_user_password_using_email</a></span>, <span class='object_link'><a href="V1/Users.html#user-instance_method" title="Auth0::Api::V1::Users#user (method)">#user</a></span>, <span class='object_link'><a href="V1/Users.html#user_devices-instance_method" title="Auth0::Api::V1::Users#user_devices (method)">#user_devices</a></span>, <span class='object_link'><a href="V1/Users.html#users-instance_method" title="Auth0::Api::V1::Users#users (method)">#users</a></span>, <span class='object_link'><a href="V1/Users.html#verification_ticket-instance_method" title="Auth0::Api::V1::Users#verification_ticket (method)">#verification_ticket</a></span></p>
|
181
|
+
|
182
|
+
|
183
|
+
</div>
|
184
|
+
|
185
|
+
<div id="footer">
|
186
|
+
Generated on Mon Jan 26 03:18:46 2015 by
|
187
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
188
|
+
0.8.7.6 (ruby-2.0.0).
|
189
|
+
</div>
|
190
|
+
|
191
|
+
</body>
|
192
|
+
</html>
|
@@ -0,0 +1,440 @@
|
|
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::Clients
|
8
|
+
|
9
|
+
— 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/Clients.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 (C)</a> »
|
35
|
+
<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="../V1.html" title="Auth0::Api::V1 (module)">V1</a></span></span>
|
36
|
+
»
|
37
|
+
<span class="title">Clients</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::Clients
|
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/clients.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#applications" target="_parent" title="https://auth0.com/docs/api#applications">https://auth0.com/docs/api#applications</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="#clients-instance_method" title="#clients (instance method)">- (Object) <strong>clients</strong> </a>
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
(also: #get_clients)
|
125
|
+
|
126
|
+
</span>
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
<span class="summary_desc"><div class='inline'>
|
137
|
+
<p><a href="https://auth0.com/docs/api#!#get–api-clients" target="_parent" title="https://auth0.com/docs/api#!#get–api-clients">https://auth0.com/docs/api#!#get–api-clients</a>.</p>
|
138
|
+
</div></span>
|
139
|
+
|
140
|
+
</li>
|
141
|
+
|
142
|
+
|
143
|
+
<li class="public ">
|
144
|
+
<span class="summary_signature">
|
145
|
+
|
146
|
+
<a href="#create_client-instance_method" title="#create_client (instance method)">- (Object) <strong>create_client</strong>(name, callbacks = "") </a>
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
</span>
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
<span class="summary_desc"><div class='inline'>
|
161
|
+
<p><a href="https://auth0.com/docs/api#!#post–api-clients" target="_parent" title="https://auth0.com/docs/api#!#post–api-clients">https://auth0.com/docs/api#!#post–api-clients</a>.</p>
|
162
|
+
</div></span>
|
163
|
+
|
164
|
+
</li>
|
165
|
+
|
166
|
+
|
167
|
+
<li class="public ">
|
168
|
+
<span class="summary_signature">
|
169
|
+
|
170
|
+
<a href="#patch_client-instance_method" title="#patch_client (instance method)">- (Object) <strong>patch_client</strong>(name, callbacks = "", client_id = @client_id) </a>
|
171
|
+
|
172
|
+
|
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#!#patch–api-clients–client-id-" target="_parent" title="https://auth0.com/docs/api#!#patch–api-clients–client-id-">https://auth0.com/docs/api#!#patch–api-clients–client-id-</a>.</p>
|
186
|
+
</div></span>
|
187
|
+
|
188
|
+
</li>
|
189
|
+
|
190
|
+
|
191
|
+
<li class="public deprecated">
|
192
|
+
<span class="summary_signature">
|
193
|
+
|
194
|
+
<a href="#update_client-instance_method" title="#update_client (instance method)">- (Object) <strong>update_client</strong>(name, callbacks = "", client_id = @client_id) </a>
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
</span>
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
<span class="deprecated note title">deprecated</span>
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
<span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'>
|
209
|
+
<p>use <span class='object_link'><a href="#patch_client-instance_method" title="Auth0::Api::V1::Clients#patch_client (method)">#patch_client</a></span></p>
|
210
|
+
</div></span>
|
211
|
+
|
212
|
+
</li>
|
213
|
+
|
214
|
+
|
215
|
+
</ul>
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
<div id="instance_method_details" class="method_details_list">
|
221
|
+
<h2>Instance Method Details</h2>
|
222
|
+
|
223
|
+
|
224
|
+
<div class="method_details first">
|
225
|
+
<h3 class="signature first" id="clients-instance_method">
|
226
|
+
|
227
|
+
- (<tt>Object</tt>) <strong>clients</strong>
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
<span class="aliases">Also known as:
|
232
|
+
<span class="names"><span id='get_clients-instance_method'>get_clients</span></span>
|
233
|
+
</span>
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
</h3><div class="docstring">
|
238
|
+
<div class="discussion">
|
239
|
+
|
240
|
+
<p><a href="https://auth0.com/docs/api#!#get–api-clients" target="_parent" title="https://auth0.com/docs/api#!#get–api-clients">https://auth0.com/docs/api#!#get–api-clients</a></p>
|
241
|
+
|
242
|
+
|
243
|
+
</div>
|
244
|
+
</div>
|
245
|
+
<div class="tags">
|
246
|
+
|
247
|
+
|
248
|
+
</div><table class="source_code">
|
249
|
+
<tr>
|
250
|
+
<td>
|
251
|
+
<pre class="lines">
|
252
|
+
|
253
|
+
|
254
|
+
7
|
255
|
+
8
|
256
|
+
9
|
257
|
+
10</pre>
|
258
|
+
</td>
|
259
|
+
<td>
|
260
|
+
<pre class="code"><span class="info file"># File 'lib/auth0/api/v1/clients.rb', line 7</span>
|
261
|
+
|
262
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_clients'>clients</span>
|
263
|
+
<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/clients</span><span class='tstring_end'>"</span></span>
|
264
|
+
<span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
265
|
+
<span class='kw'>end</span></pre>
|
266
|
+
</td>
|
267
|
+
</tr>
|
268
|
+
</table>
|
269
|
+
</div>
|
270
|
+
|
271
|
+
<div class="method_details ">
|
272
|
+
<h3 class="signature " id="create_client-instance_method">
|
273
|
+
|
274
|
+
- (<tt>Object</tt>) <strong>create_client</strong>(name, callbacks = "")
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
</h3><div class="docstring">
|
281
|
+
<div class="discussion">
|
282
|
+
|
283
|
+
<p><a href="https://auth0.com/docs/api#!#post–api-clients" target="_parent" title="https://auth0.com/docs/api#!#post–api-clients">https://auth0.com/docs/api#!#post–api-clients</a></p>
|
284
|
+
|
285
|
+
|
286
|
+
</div>
|
287
|
+
</div>
|
288
|
+
<div class="tags">
|
289
|
+
|
290
|
+
|
291
|
+
</div><table class="source_code">
|
292
|
+
<tr>
|
293
|
+
<td>
|
294
|
+
<pre class="lines">
|
295
|
+
|
296
|
+
|
297
|
+
15
|
298
|
+
16
|
299
|
+
17
|
300
|
+
18
|
301
|
+
19
|
302
|
+
20
|
303
|
+
21
|
304
|
+
22</pre>
|
305
|
+
</td>
|
306
|
+
<td>
|
307
|
+
<pre class="code"><span class="info file"># File 'lib/auth0/api/v1/clients.rb', line 15</span>
|
308
|
+
|
309
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create_client'>create_client</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_callbacks'>callbacks</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
310
|
+
<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/clients</span><span class='tstring_end'>"</span></span>
|
311
|
+
<span class='id identifier rubyid_request_params'>request_params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
312
|
+
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
|
313
|
+
<span class='label'>callbacks:</span> <span class='id identifier rubyid_callbacks'>callbacks</span>
|
314
|
+
<span class='rbrace'>}</span>
|
315
|
+
<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>
|
316
|
+
<span class='kw'>end</span></pre>
|
317
|
+
</td>
|
318
|
+
</tr>
|
319
|
+
</table>
|
320
|
+
</div>
|
321
|
+
|
322
|
+
<div class="method_details ">
|
323
|
+
<h3 class="signature " id="patch_client-instance_method">
|
324
|
+
|
325
|
+
- (<tt>Object</tt>) <strong>patch_client</strong>(name, callbacks = "", client_id = @client_id)
|
326
|
+
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
|
331
|
+
</h3><div class="docstring">
|
332
|
+
<div class="discussion">
|
333
|
+
|
334
|
+
<p><a href="https://auth0.com/docs/api#!#patch–api-clients–client-id-" target="_parent" title="https://auth0.com/docs/api#!#patch–api-clients–client-id-">https://auth0.com/docs/api#!#patch–api-clients–client-id-</a></p>
|
335
|
+
|
336
|
+
|
337
|
+
</div>
|
338
|
+
</div>
|
339
|
+
<div class="tags">
|
340
|
+
|
341
|
+
|
342
|
+
</div><table class="source_code">
|
343
|
+
<tr>
|
344
|
+
<td>
|
345
|
+
<pre class="lines">
|
346
|
+
|
347
|
+
|
348
|
+
37
|
349
|
+
38
|
350
|
+
39
|
351
|
+
40
|
352
|
+
41
|
353
|
+
42
|
354
|
+
43
|
355
|
+
44</pre>
|
356
|
+
</td>
|
357
|
+
<td>
|
358
|
+
<pre class="code"><span class="info file"># File 'lib/auth0/api/v1/clients.rb', line 37</span>
|
359
|
+
|
360
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_patch_client'>patch_client</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_callbacks'>callbacks</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</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>
|
361
|
+
<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/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_end'>"</span></span>
|
362
|
+
<span class='id identifier rubyid_request_params'>request_params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
363
|
+
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
|
364
|
+
<span class='label'>callbacks:</span> <span class='id identifier rubyid_callbacks'>callbacks</span>
|
365
|
+
<span class='rbrace'>}</span>
|
366
|
+
<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_request_params'>request_params</span><span class='rparen'>)</span>
|
367
|
+
<span class='kw'>end</span></pre>
|
368
|
+
</td>
|
369
|
+
</tr>
|
370
|
+
</table>
|
371
|
+
</div>
|
372
|
+
|
373
|
+
<div class="method_details ">
|
374
|
+
<h3 class="signature " id="update_client-instance_method">
|
375
|
+
|
376
|
+
- (<tt>Object</tt>) <strong>update_client</strong>(name, callbacks = "", client_id = @client_id)
|
377
|
+
|
378
|
+
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
</h3><div class="docstring">
|
383
|
+
<div class="discussion">
|
384
|
+
<div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'>
|
385
|
+
<p>use <span class='object_link'><a href="#patch_client-instance_method" title="Auth0::Api::V1::Clients#patch_client (method)">#patch_client</a></span></p>
|
386
|
+
</div></div>
|
387
|
+
|
388
|
+
<p><a href="https://auth0.com/docs/api#!#put–api-clients–client-id-" target="_parent" title="https://auth0.com/docs/api#!#put–api-clients–client-id-">https://auth0.com/docs/api#!#put–api-clients–client-id-</a></p>
|
389
|
+
|
390
|
+
|
391
|
+
</div>
|
392
|
+
</div>
|
393
|
+
<div class="tags">
|
394
|
+
|
395
|
+
|
396
|
+
</div><table class="source_code">
|
397
|
+
<tr>
|
398
|
+
<td>
|
399
|
+
<pre class="lines">
|
400
|
+
|
401
|
+
|
402
|
+
26
|
403
|
+
27
|
404
|
+
28
|
405
|
+
29
|
406
|
+
30
|
407
|
+
31
|
408
|
+
32
|
409
|
+
33
|
410
|
+
34</pre>
|
411
|
+
</td>
|
412
|
+
<td>
|
413
|
+
<pre class="code"><span class="info file"># File 'lib/auth0/api/v1/clients.rb', line 26</span>
|
414
|
+
|
415
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update_client'>update_client</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_callbacks'>callbacks</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</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>
|
416
|
+
<span class='id identifier rubyid_warn'>warn</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>This endpoint has been deprecated in favor of PUT.</span><span class='tstring_end'>"</span></span>
|
417
|
+
<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/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_end'>"</span></span>
|
418
|
+
<span class='id identifier rubyid_request_params'>request_params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
419
|
+
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
|
420
|
+
<span class='label'>callbacks:</span> <span class='id identifier rubyid_callbacks'>callbacks</span>
|
421
|
+
<span class='rbrace'>}</span>
|
422
|
+
<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>
|
423
|
+
<span class='kw'>end</span></pre>
|
424
|
+
</td>
|
425
|
+
</tr>
|
426
|
+
</table>
|
427
|
+
</div>
|
428
|
+
|
429
|
+
</div>
|
430
|
+
|
431
|
+
</div>
|
432
|
+
|
433
|
+
<div id="footer">
|
434
|
+
Generated on Mon Jan 26 03:18:46 2015 by
|
435
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
436
|
+
0.8.7.6 (ruby-2.0.0).
|
437
|
+
</div>
|
438
|
+
|
439
|
+
</body>
|
440
|
+
</html>
|