auth0 2.36.2 → 2.39.0
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.
- package/CHANGELOG.md +41 -0
- package/README.md +33 -11
- package/package.json +22 -14
- package/src/Auth0RestClient.js +72 -71
- package/src/RetryRestClient.js +78 -81
- package/src/auth/DatabaseAuthenticator.js +242 -259
- package/src/auth/OAUthWithIDTokenValidation.js +99 -103
- package/src/auth/OAuthAuthenticator.js +325 -344
- package/src/auth/PasswordlessAuthenticator.js +238 -252
- package/src/auth/TokensManager.js +231 -246
- package/src/auth/UsersManager.js +149 -160
- package/src/auth/idToken.js +22 -19
- package/src/auth/index.js +510 -581
- package/src/errors.js +23 -23
- package/src/index.js +3 -2
- package/src/management/ActionsManager.js +510 -584
- package/src/management/BlacklistedTokensManager.js +77 -84
- package/src/management/BrandingManager.js +141 -163
- package/src/management/ClientGrantsManager.js +132 -145
- package/src/management/ClientsManager.js +145 -161
- package/src/management/ConnectionsManager.js +215 -204
- package/src/management/CustomDomainsManager.js +140 -157
- package/src/management/DeviceCredentialsManager.js +95 -111
- package/src/management/EmailProviderManager.js +110 -128
- package/src/management/EmailTemplatesManager.js +96 -112
- package/src/management/GrantsManager.js +94 -101
- package/src/management/GuardianManager.js +381 -455
- package/src/management/HooksManager.js +283 -325
- package/src/management/JobsManager.js +310 -343
- package/src/management/LogStreamsManager.js +142 -158
- package/src/management/LogsManager.js +92 -99
- package/src/management/ManagementTokenProvider.js +112 -120
- package/src/management/MigrationsManager.js +81 -90
- package/src/management/OrganizationsManager.js +686 -761
- package/src/management/PromptsManager.js +160 -182
- package/src/management/ResourceServersManager.js +143 -160
- package/src/management/RolesManager.js +323 -369
- package/src/management/RulesConfigsManager.js +94 -110
- package/src/management/RulesManager.js +154 -176
- package/src/management/StatsManager.js +87 -103
- package/src/management/TenantManager.js +81 -97
- package/src/management/TicketsManager.js +107 -115
- package/src/management/UserBlocksManager.js +135 -162
- package/src/management/UsersManager.js +729 -852
- package/src/management/index.js +3094 -3619
- package/src/utils.js +31 -60
|
@@ -1,10 +1,8 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
var RetryRestClient = require('../RetryRestClient');
|
|
1
|
+
const { ArgumentError } = require('rest-facade');
|
|
2
|
+
const Auth0RestClient = require('../Auth0RestClient');
|
|
3
|
+
const RetryRestClient = require('../RetryRestClient');
|
|
5
4
|
|
|
6
5
|
/**
|
|
7
|
-
* @class ResourceServersManager
|
|
8
6
|
* Auth0 Resource Servers Manager.
|
|
9
7
|
*
|
|
10
8
|
* {@link https://auth0.com/docs/api/management/v2#!/Resource_Servers Resource Servers} represents
|
|
@@ -12,176 +10,161 @@ var RetryRestClient = require('../RetryRestClient');
|
|
|
12
10
|
* You can learn more about this in the
|
|
13
11
|
* {@link https://auth0.com/docs/api-auth API Authorization} section of the
|
|
14
12
|
* documentation.
|
|
15
|
-
* @constructor
|
|
16
|
-
* @memberOf module:management
|
|
17
|
-
*
|
|
18
|
-
* @param {Object} options The client options.
|
|
19
|
-
* @param {String} options.baseUrl The URL of the API.
|
|
20
|
-
* @param {Object} [options.headers] Headers to be included in all requests.
|
|
21
|
-
* @param {Object} [options.retry] Retry Policy Config
|
|
22
13
|
*/
|
|
14
|
+
class ResourceServersManager {
|
|
15
|
+
/**
|
|
16
|
+
* @param {object} options The client options.
|
|
17
|
+
* @param {string} options.baseUrl The URL of the API.
|
|
18
|
+
* @param {object} [options.headers] Headers to be included in all requests.
|
|
19
|
+
* @param {object} [options.retry] Retry Policy Config
|
|
20
|
+
*/
|
|
21
|
+
constructor(options) {
|
|
22
|
+
if (options === null || typeof options !== 'object') {
|
|
23
|
+
throw new ArgumentError('Must provide resource server options');
|
|
24
|
+
}
|
|
23
25
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
}
|
|
26
|
+
if (options.baseUrl === null || options.baseUrl === undefined) {
|
|
27
|
+
throw new ArgumentError('Must provide a base URL for the API');
|
|
28
|
+
}
|
|
28
29
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
30
|
+
if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
|
|
31
|
+
throw new ArgumentError('The provided base URL is invalid');
|
|
32
|
+
}
|
|
32
33
|
|
|
33
|
-
|
|
34
|
-
|
|
34
|
+
/**
|
|
35
|
+
* Options object for the Rest Client instance.
|
|
36
|
+
*
|
|
37
|
+
* @type {object}
|
|
38
|
+
*/
|
|
39
|
+
const clientOptions = {
|
|
40
|
+
headers: options.headers,
|
|
41
|
+
query: { repeatParams: false },
|
|
42
|
+
};
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Provides an abstraction layer for consuming the
|
|
46
|
+
* {@link https://auth0.com/docs/api/v2#!/ResourceServers Auth0 Resource Servers endpoint}.
|
|
47
|
+
*
|
|
48
|
+
* @type {external:RestClient}
|
|
49
|
+
*/
|
|
50
|
+
const auth0RestClient = new Auth0RestClient(
|
|
51
|
+
`${options.baseUrl}/resource-servers/:id`,
|
|
52
|
+
clientOptions,
|
|
53
|
+
options.tokenProvider
|
|
54
|
+
);
|
|
55
|
+
this.resource = new RetryRestClient(auth0RestClient, options.retry);
|
|
35
56
|
}
|
|
36
57
|
|
|
37
58
|
/**
|
|
38
|
-
*
|
|
59
|
+
* Create an API (Resource Server).
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* management.resourceServers.create(data, function (err) {
|
|
63
|
+
* if (err) {
|
|
64
|
+
* // Handle error.
|
|
65
|
+
* }
|
|
39
66
|
*
|
|
40
|
-
*
|
|
67
|
+
* // Resource Server created.
|
|
68
|
+
* });
|
|
69
|
+
* @param {object} data Resource Server data object.
|
|
70
|
+
* @param {Function} [cb] Callback function.
|
|
71
|
+
* @returns {Promise|undefined}
|
|
41
72
|
*/
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
};
|
|
73
|
+
create(...args) {
|
|
74
|
+
return this.resource.create(...args);
|
|
75
|
+
}
|
|
46
76
|
|
|
47
77
|
/**
|
|
48
|
-
*
|
|
49
|
-
*
|
|
78
|
+
* Get all resource servers.
|
|
79
|
+
*
|
|
80
|
+
* @example <caption>
|
|
81
|
+
* This method takes an optional object as first argument that may be used to
|
|
82
|
+
* specify pagination settings. If pagination options are not present,
|
|
83
|
+
* the first page of a limited number of results will be returned.
|
|
84
|
+
* </caption>
|
|
50
85
|
*
|
|
51
|
-
*
|
|
86
|
+
* // Pagination settings.
|
|
87
|
+
* var params = {
|
|
88
|
+
* per_page: 10,
|
|
89
|
+
* page: 0
|
|
90
|
+
* };
|
|
91
|
+
*
|
|
92
|
+
* management.resourceServers.getAll(params, function (err, resourceServers) {
|
|
93
|
+
* console.log(resourceServers.length);
|
|
94
|
+
* });
|
|
95
|
+
* @param {object} [params] Resource Servers parameters.
|
|
96
|
+
* @param {number} [params.per_page] Number of results per page.
|
|
97
|
+
* @param {number} [params.page] Page number, zero indexed.
|
|
98
|
+
* @param {Function} [cb] Callback function.
|
|
99
|
+
* @returns {Promise|undefined}
|
|
52
100
|
*/
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
options.tokenProvider
|
|
57
|
-
);
|
|
58
|
-
this.resource = new RetryRestClient(auth0RestClient, options.retry);
|
|
59
|
-
};
|
|
60
|
-
|
|
61
|
-
/**
|
|
62
|
-
* Create an API (Resource Server).
|
|
63
|
-
*
|
|
64
|
-
* @method create
|
|
65
|
-
* @memberOf module:management.ResourceServersManager.prototype
|
|
66
|
-
*
|
|
67
|
-
* @example
|
|
68
|
-
* management.resourceServers.create(data, function (err) {
|
|
69
|
-
* if (err) {
|
|
70
|
-
* // Handle error.
|
|
71
|
-
* }
|
|
72
|
-
*
|
|
73
|
-
* // Resource Server created.
|
|
74
|
-
* });
|
|
75
|
-
*
|
|
76
|
-
* @param {Object} data Resource Server data object.
|
|
77
|
-
* @param {Function} [cb] Callback function.
|
|
78
|
-
*
|
|
79
|
-
* @return {Promise|undefined}
|
|
80
|
-
*/
|
|
81
|
-
utils.wrapPropertyMethod(ResourceServersManager, 'create', 'resource.create');
|
|
82
|
-
|
|
83
|
-
/**
|
|
84
|
-
* Get all resource servers.
|
|
85
|
-
*
|
|
86
|
-
* @method getAll
|
|
87
|
-
* @memberOf module:management.ResourceServersManager.prototype
|
|
88
|
-
*
|
|
89
|
-
* @example <caption>
|
|
90
|
-
* This method takes an optional object as first argument that may be used to
|
|
91
|
-
* specify pagination settings. If pagination options are not present,
|
|
92
|
-
* the first page of a limited number of results will be returned.
|
|
93
|
-
* </caption>
|
|
94
|
-
*
|
|
95
|
-
* // Pagination settings.
|
|
96
|
-
* var params = {
|
|
97
|
-
* per_page: 10,
|
|
98
|
-
* page: 0
|
|
99
|
-
* };
|
|
100
|
-
*
|
|
101
|
-
* management.resourceServers.getAll(params, function (err, resourceServers) {
|
|
102
|
-
* console.log(resourceServers.length);
|
|
103
|
-
* });
|
|
104
|
-
*
|
|
105
|
-
* @param {Object} [params] Resource Servers parameters.
|
|
106
|
-
* @param {Number} [params.per_page] Number of results per page.
|
|
107
|
-
* @param {Number} [params.page] Page number, zero indexed.
|
|
108
|
-
* @param {Function} [cb] Callback function.
|
|
109
|
-
*
|
|
110
|
-
* @return {Promise|undefined}
|
|
111
|
-
*/
|
|
112
|
-
utils.wrapPropertyMethod(ResourceServersManager, 'getAll', 'resource.getAll');
|
|
101
|
+
getAll(...args) {
|
|
102
|
+
return this.resource.getAll(...args);
|
|
103
|
+
}
|
|
113
104
|
|
|
114
|
-
/**
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
* @return {Promise|undefined}
|
|
134
|
-
*/
|
|
135
|
-
utils.wrapPropertyMethod(ResourceServersManager, 'get', 'resource.get');
|
|
105
|
+
/**
|
|
106
|
+
* Get a Resource Server.
|
|
107
|
+
*
|
|
108
|
+
* @example
|
|
109
|
+
* management.resourceServers.get({ id: RESOURCE_SERVER_ID }, function (err, resourceServer) {
|
|
110
|
+
* if (err) {
|
|
111
|
+
* // Handle error.
|
|
112
|
+
* }
|
|
113
|
+
*
|
|
114
|
+
* console.log(resourceServer);
|
|
115
|
+
* });
|
|
116
|
+
* @param {object} params Resource Server parameters.
|
|
117
|
+
* @param {string} params.id Resource Server ID.
|
|
118
|
+
* @param {Function} [cb] Callback function.
|
|
119
|
+
* @returns {Promise|undefined}
|
|
120
|
+
*/
|
|
121
|
+
get(...args) {
|
|
122
|
+
return this.resource.get(...args);
|
|
123
|
+
}
|
|
136
124
|
|
|
137
|
-
/**
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
* @return {Promise|undefined}
|
|
161
|
-
*/
|
|
162
|
-
utils.wrapPropertyMethod(ResourceServersManager, 'update', 'resource.patch');
|
|
125
|
+
/**
|
|
126
|
+
* Update an existing resource server.
|
|
127
|
+
*
|
|
128
|
+
* @example
|
|
129
|
+
* var data = { name: 'newResourceServerName' };
|
|
130
|
+
* var params = { id: RESOURCE_SERVER_ID };
|
|
131
|
+
*
|
|
132
|
+
* management.resourceServers.update(params, data, function (err, resourceServer) {
|
|
133
|
+
* if (err) {
|
|
134
|
+
* // Handle error.
|
|
135
|
+
* }
|
|
136
|
+
*
|
|
137
|
+
* console.log(resourceServer.name); // 'newResourceServernName'
|
|
138
|
+
* });
|
|
139
|
+
* @param {object} params Resource Server parameters.
|
|
140
|
+
* @param {string} params.id Resource Server ID.
|
|
141
|
+
* @param {object} data Updated Resource Server data.
|
|
142
|
+
* @param {Function} [cb] Callback function.
|
|
143
|
+
* @returns {Promise|undefined}
|
|
144
|
+
*/
|
|
145
|
+
update(...args) {
|
|
146
|
+
return this.resource.patch(...args);
|
|
147
|
+
}
|
|
163
148
|
|
|
164
|
-
/**
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
*/
|
|
185
|
-
utils.wrapPropertyMethod(ResourceServersManager, 'delete', 'resource.delete');
|
|
149
|
+
/**
|
|
150
|
+
* Delete an existing Resource Server.
|
|
151
|
+
*
|
|
152
|
+
* @example
|
|
153
|
+
* management.resourceServers.delete({ id: RESOURCE_SERVER_ID }, function (err) {
|
|
154
|
+
* if (err) {
|
|
155
|
+
* // Handle error.
|
|
156
|
+
* }
|
|
157
|
+
*
|
|
158
|
+
* // Resource Server deleted.
|
|
159
|
+
* });
|
|
160
|
+
* @param {object} params Resource Server parameters.
|
|
161
|
+
* @param {string} params.id Resource Server ID.
|
|
162
|
+
* @param {Function} [cb] Callback function.
|
|
163
|
+
* @returns {Promise|undefined}
|
|
164
|
+
*/
|
|
165
|
+
delete(...args) {
|
|
166
|
+
return this.resource.delete(...args);
|
|
167
|
+
}
|
|
168
|
+
}
|
|
186
169
|
|
|
187
170
|
module.exports = ResourceServersManager;
|