@strapi/plugin-users-permissions 4.3.0-beta.1 → 4.3.0-beta.2

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.
@@ -1,281 +0,0 @@
1
- {
2
- "paths": {
3
- "/users-permissions/init": {
4
- "get": {
5
- "responses": {
6
- "200": {
7
- "description": "Response",
8
- "content": {
9
- "application/json": {
10
- "schema": {
11
- "properties": {
12
- "hasAdmin": {
13
- "type": "boolean"
14
- }
15
- }
16
- }
17
- }
18
- }
19
- }
20
- }
21
- }
22
- },
23
- "/users-permissions/roles/{id}": {
24
- "get": {
25
- "responses": {
26
- "200": {
27
- "content": {
28
- "application/json": {
29
- "schema": {
30
- "properties": {
31
- "id": {
32
- "type": "string"
33
- },
34
- "name": {
35
- "type": "string",
36
- "minLength": 3
37
- },
38
- "description": {
39
- "type": "string"
40
- },
41
- "type": {
42
- "type": "string"
43
- },
44
- "permissions": {
45
- "type": "array",
46
- "items": {
47
- "required": ["id", "type", "controller", "action", "enabled"],
48
- "properties": {
49
- "id": {
50
- "type": "string"
51
- },
52
- "type": {
53
- "type": "string"
54
- },
55
- "controller": {
56
- "type": "string"
57
- },
58
- "action": {
59
- "type": "string"
60
- },
61
- "enabled": {
62
- "type": "boolean"
63
- },
64
- "policy": {
65
- "type": "string"
66
- },
67
- "role": {
68
- "type": "string"
69
- },
70
- "createdBy": {
71
- "type": "string"
72
- },
73
- "updatedBy": {
74
- "type": "string"
75
- }
76
- }
77
- }
78
- },
79
- "createdBy": {
80
- "required": ["id", "email"],
81
- "properties": {
82
- "id": {
83
- "type": "string"
84
- },
85
- "firstname": {
86
- "type": "string"
87
- },
88
- "lastname": {
89
- "type": "string"
90
- },
91
- "username": {
92
- "type": "string"
93
- },
94
- "email": {
95
- "type": "string"
96
- },
97
- "password": {
98
- "type": "string"
99
- },
100
- "resetPasswordToken": {
101
- "type": "string"
102
- },
103
- "registrationToken": {
104
- "type": "string"
105
- },
106
- "isActive": {
107
- "type": "boolean"
108
- },
109
- "roles": {
110
- "type": "array",
111
- "items": {
112
- "type": "string"
113
- }
114
- },
115
- "blocked": {
116
- "type": "boolean"
117
- }
118
- }
119
- },
120
- "updatedBy": {
121
- "required": ["id", "email"],
122
- "properties": {
123
- "id": {
124
- "type": "string"
125
- },
126
- "firstname": {
127
- "type": "string"
128
- },
129
- "lastname": {
130
- "type": "string"
131
- },
132
- "username": {
133
- "type": "string"
134
- },
135
- "email": {
136
- "type": "string"
137
- },
138
- "password": {
139
- "type": "string"
140
- },
141
- "resetPasswordToken": {
142
- "type": "string"
143
- },
144
- "registrationToken": {
145
- "type": "string"
146
- },
147
- "isActive": {
148
- "type": "boolean"
149
- },
150
- "roles": {
151
- "type": "array",
152
- "items": {
153
- "type": "string"
154
- }
155
- },
156
- "blocked": {
157
- "type": "boolean"
158
- }
159
- }
160
- }
161
- }
162
- }
163
- }
164
- }
165
- }
166
- }
167
- }
168
- },
169
- "/users-permissions/roles": {
170
- "get": {
171
- "responses": {
172
- "200": {
173
- "content": {
174
- "application/json": {
175
- "schema": {
176
- "type": "array",
177
- "items": {
178
- "properties": {
179
- "id": {
180
- "type": "string"
181
- },
182
- "name": {
183
- "type": "string",
184
- "minLength": 3
185
- },
186
- "description": {
187
- "type": "string"
188
- },
189
- "nb_users": {
190
- "type": "integer"
191
- },
192
- "type": {
193
- "type": "string"
194
- },
195
- "createdBy": {
196
- "required": ["id", "email"],
197
- "properties": {
198
- "id": {
199
- "type": "string"
200
- },
201
- "firstname": {
202
- "type": "string"
203
- },
204
- "lastname": {
205
- "type": "string"
206
- },
207
- "username": {
208
- "type": "string"
209
- },
210
- "email": {
211
- "type": "string"
212
- },
213
- "password": {
214
- "type": "string"
215
- },
216
- "resetPasswordToken": {
217
- "type": "string"
218
- },
219
- "registrationToken": {
220
- "type": "string"
221
- },
222
- "isActive": {
223
- "type": "boolean"
224
- },
225
- "roles": {
226
- "type": "array",
227
- "items": {
228
- "type": "string"
229
- }
230
- },
231
- "blocked": {
232
- "type": "boolean"
233
- }
234
- }
235
- },
236
- "updatedBy": {
237
- "required": ["id", "email"],
238
- "properties": {
239
- "id": {
240
- "type": "string"
241
- },
242
- "firstname": {
243
- "type": "string"
244
- },
245
- "lastname": {
246
- "type": "string"
247
- },
248
- "username": {
249
- "type": "string"
250
- },
251
- "email": {
252
- "type": "string"
253
- },
254
- "password": {
255
- "type": "string"
256
- },
257
- "isActive": {
258
- "type": "boolean"
259
- },
260
- "roles": {
261
- "type": "array",
262
- "items": {
263
- "type": "string"
264
- }
265
- },
266
- "blocked": {
267
- "type": "boolean"
268
- }
269
- }
270
- }
271
- }
272
- }
273
- }
274
- }
275
- }
276
- }
277
- }
278
- }
279
- }
280
- }
281
- }
@@ -1,325 +0,0 @@
1
- {
2
- "paths": {
3
- "/auth/local/register": {
4
- "post": {
5
- "tags": ["Authentication"],
6
- "security": [],
7
- "externalDocs": {
8
- "description": "Find out more in the strapi's documentation",
9
- "url": "https://docs.strapi.io/developer-docs/latest/plugins/users-permissions.html#registration"
10
- },
11
- "responses": {
12
- "200": {
13
- "description": "Successfully register a user",
14
- "content": {
15
- "application/json": {
16
- "schema": {
17
- "$ref": "#/components/schemas/Users-PermissionsRegisterResponse"
18
- }
19
- }
20
- }
21
- }
22
- },
23
- "requestBody": {
24
- "description": "",
25
- "required": true,
26
- "content": {
27
- "application/json": {
28
- "schema": {
29
- "required": ["username", "email", "password"],
30
- "properties": {
31
- "username": {
32
- "type": "string",
33
- "minLength": 3
34
- },
35
- "email": {
36
- "type": "string",
37
- "minLength": 6
38
- },
39
- "password": {
40
- "type": "string",
41
- "minLength": 6
42
- }
43
- }
44
- }
45
- }
46
- }
47
- }
48
- }
49
- },
50
- "/auth/email-confirmation": {
51
- "get": {
52
- "tags": ["Authentication"],
53
- "security": []
54
- }
55
- },
56
- "/auth/send-email-confirmation": {
57
- "post": {
58
- "security": [],
59
- "externalDocs": {
60
- "description": "Find out more in the strapi's documentation",
61
- "url": "https://docs.strapi.io/developer-docs/latest/plugins/users-permissions.html#email-validation"
62
- },
63
- "responses": {
64
- "200": {
65
- "description": "Successfully sent email",
66
- "content": {
67
- "application/json": {
68
- "email": {
69
- "type": "string"
70
- },
71
- "sent": {
72
- "type": "boolean"
73
- }
74
- }
75
- }
76
- }
77
- },
78
- "requestBody": {
79
- "description": "",
80
- "required": true,
81
- "content": {
82
- "application/json": {
83
- "schema": {
84
- "required": ["email"],
85
- "properties": {
86
- "email": {
87
- "type": "string",
88
- "minLength": 6
89
- }
90
- }
91
- }
92
- }
93
- }
94
- }
95
- }
96
- },
97
- "/users-permissions/search/{id}": {
98
- "get": {
99
- "summary": "Retrieve a list of users by searching for their username or email",
100
- "parameters": [
101
- {
102
- "name": "id",
103
- "in": "path",
104
- "description": "A string matching a user's email or username",
105
- "deprecated": false,
106
- "required": true,
107
- "schema": {
108
- "type": "string"
109
- }
110
- }
111
- ]
112
- }
113
- },
114
- "/connect/*": {
115
- "get": {
116
- "summary": "Authenticate your user with a custom provider",
117
- "tags": ["Authentication"],
118
- "security": [],
119
- "parameters": [
120
- {
121
- "name": "provider",
122
- "in": "path",
123
- "required": true,
124
- "deprecated": false,
125
- "description": "The name of the provider you want to use",
126
- "schema": {
127
- "type": "string"
128
- }
129
- }
130
- ],
131
- "externalDocs": {
132
- "description": "Find out more about the authentication flow in the strapi documentation",
133
- "url": "https://docs.strapi.io/developer-docs/latest/plugins/users-permissions.html#providers"
134
- },
135
- "responses": {
136
- "200": {
137
- "description": "Your user is redirected"
138
- }
139
- }
140
- }
141
- },
142
- "/auth/local": {
143
- "post": {
144
- "externalDocs": {
145
- "description": "Find out more in the strapi's documentation",
146
- "url": "https://docs.strapi.io/developer-docs/latest/plugins/users-permissions.html#login"
147
- },
148
- "tags": ["Authentication"],
149
- "security": [],
150
- "requestBody": {
151
- "description": "The identifier param can either be an email or a username",
152
- "content": {
153
- "application/json": {
154
- "schema": {
155
- "required": ["identifier", "password"],
156
- "properties": {
157
- "identifier": {
158
- "type": "string"
159
- },
160
- "password": {
161
- "type": "string"
162
- }
163
- }
164
- },
165
- "example": {
166
- "identifier": "hi@strapi.io",
167
- "password": "superSecure123"
168
- }
169
- }
170
- }
171
- },
172
- "responses": {
173
- "200": {
174
- "description": "Response",
175
- "content": {
176
- "application/json": {
177
- "schema": {
178
- "$ref": "#/components/schemas/Users-PermissionsRegisterResponse"
179
- }
180
- }
181
- }
182
- }
183
- }
184
- }
185
- },
186
- "/auth/{provider}/callback": {
187
- "get": {
188
- "tags": ["Authentication"],
189
- "externalDocs": {
190
- "description": "Find out more in the strapi's documentation",
191
- "url": "https://docs.strapi.io/developer-docs/latest/plugins/users-permissions.html#providers"
192
- },
193
- "parameters": [
194
- {
195
- "name": "provider",
196
- "in": "path",
197
- "description": "The provider used to authenticate your user",
198
- "deprecated": false,
199
- "required": true,
200
- "schema": {
201
- "type": "string"
202
- }
203
- }
204
- ],
205
- "responses": {
206
- "200": {
207
- "description": "Successfull redirection after approving a provider",
208
- "content": {
209
- "application/json": {
210
- "schema": {
211
- "$ref": "#/components/schemas/Users-PermissionsRegisterResponse"
212
- }
213
- }
214
- }
215
- }
216
- }
217
- }
218
- },
219
- "/auth/forgot-password": {
220
- "post": {
221
- "tags": ["Authentication"],
222
- "security": [],
223
- "summary": "Send an email to reset your password",
224
- "externalDocs": {
225
- "description": "Find out more in the strapi's documentation",
226
- "url": "https://docs.strapi.io/developer-docs/latest/plugins/users-permissions.html#forgotten-reset-password"
227
- },
228
- "requestBody": {
229
- "description": "",
230
- "required": true,
231
- "content": {
232
- "application/json": {
233
- "schema": {
234
- "properties": {
235
- "email": {
236
- "type": "string"
237
- },
238
- "url": {
239
- "type": "string"
240
- }
241
- }
242
- },
243
- "example": {
244
- "email": "hi@strapi.io",
245
- "url": "http://mon-site.com/rest-password"
246
- }
247
- }
248
- }
249
- },
250
- "responses": {
251
- "200": {
252
- "description": "Email sent"
253
- }
254
- }
255
- }
256
- },
257
- "/auth/reset-password": {
258
- "post": {
259
- "tags": ["Authentication"],
260
- "security": [],
261
- "responses": {
262
- "200": {
263
- "description": "response",
264
- "content": {
265
- "application/json": {
266
- "schema": {
267
- "$ref": "#/components/schemas/Users-PermissionsRegisterResponse"
268
- }
269
- }
270
- }
271
- }
272
- },
273
- "requestBody": {
274
- "description": "",
275
- "required": true,
276
- "content": {
277
- "application/json": {
278
- "schema": {
279
- "required": ["code", "password", "passwordConfirmation"],
280
- "properties": {
281
- "code": {
282
- "type": "string"
283
- },
284
- "password": {
285
- "type": "string"
286
- },
287
- "passwordConfirmation": {
288
- "type": "string"
289
- }
290
- }
291
- }
292
- }
293
- }
294
- }
295
- }
296
- }
297
- },
298
- "components": {
299
- "schemas": {
300
- "Users-PermissionsRegisterResponse": {
301
- "properties": {
302
- "jwt": {
303
- "type": "string"
304
- },
305
- "user": {
306
- "$ref": "#/components/schemas/Users-PermissionsUser"
307
- }
308
- }
309
- }
310
- }
311
- },
312
- "tags": [
313
- {
314
- "name": "Authentication",
315
- "description": "All the routes related to the authentication",
316
- "externalDocs": {
317
- "description": "Find out more in strapi's documentation",
318
- "url": "https://docs.strapi.io/developer-docs/latest/plugins/users-permissions.html"
319
- }
320
- },
321
- {
322
- "name": "Users-Permissions - User"
323
- }
324
- ]
325
- }