mirror of
https://github.com/strapi/strapi.git
synced 2025-08-31 12:23:05 +00:00
1211 lines
30 KiB
JSON
1211 lines
30 KiB
JSON
{
|
|
"paths": {
|
|
"/users-permissions/search/{id}": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Search for users",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Users-PermissionsUser"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"summary": "",
|
|
"tags": [
|
|
"Users-Permissions - User"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "_limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Maximum number of results possible",
|
|
"schema": {
|
|
"type": "integer"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_sort",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Sort according to a specific field.",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_start",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Skip a specific number of entries (especially useful for pagination)",
|
|
"schema": {
|
|
"type": "integer"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "=",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get entries that matches exactly your input",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_ne",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get records that are not equals to something",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_lt",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get record that are lower than a value",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_lte",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get records that are lower than or equal to a value",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_gt",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get records that are greater than a value",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_gte",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get records that are greater than or equal a value",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_contains",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get records that contains a value",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_containss",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get records that contains (case sensitive) a value",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_in",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get records that matches any value in the array of values",
|
|
"schema": {
|
|
"type": "array"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_nin",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get records that doesn't match any value in the array of values",
|
|
"schema": {
|
|
"type": "array"
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/connect/*": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Connect a provider",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"summary": "",
|
|
"tags": [
|
|
"Users-Permissions - User"
|
|
],
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/auth/local": {
|
|
"post": {
|
|
"deprecated": false,
|
|
"description": "Login a user using the identifiers email and password",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"summary": "",
|
|
"tags": [
|
|
"Users-Permissions - User"
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/local/register": {
|
|
"post": {
|
|
"deprecated": false,
|
|
"description": "Register a new user with the default role",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Users-PermissionsUser"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"summary": "",
|
|
"tags": [
|
|
"Users-Permissions - User"
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NewUsers-PermissionsUser"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/{provider}/callback": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Successfull redirection after approving a provider",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"summary": "",
|
|
"tags": [
|
|
"Users-Permissions - User"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "provider",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/auth/forgot-password": {
|
|
"post": {
|
|
"deprecated": false,
|
|
"description": "Send the reset password email link",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"summary": "",
|
|
"tags": [
|
|
"Users-Permissions - User"
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/reset-password": {
|
|
"post": {
|
|
"deprecated": false,
|
|
"description": "Change a user's password",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"summary": "",
|
|
"tags": [
|
|
"Users-Permissions - User"
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/auth/email-confirmation": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Validate a user account",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"summary": "",
|
|
"tags": [
|
|
"Users-Permissions - User"
|
|
],
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/users": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Retrieve all user documents",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Users-PermissionsUser"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"summary": "",
|
|
"tags": [
|
|
"Users-Permissions - User"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "_limit",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Maximum number of results possible",
|
|
"schema": {
|
|
"type": "integer"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_sort",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Sort according to a specific field.",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_start",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Skip a specific number of entries (especially useful for pagination)",
|
|
"schema": {
|
|
"type": "integer"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "=",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get entries that matches exactly your input",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_ne",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get records that are not equals to something",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_lt",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get record that are lower than a value",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_lte",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get records that are lower than or equal to a value",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_gt",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get records that are greater than a value",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_gte",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get records that are greater than or equal a value",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_contains",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get records that contains a value",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_containss",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get records that contains (case sensitive) a value",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_in",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get records that matches any value in the array of values",
|
|
"schema": {
|
|
"type": "array"
|
|
},
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"name": "_nin",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "Get records that doesn't match any value in the array of values",
|
|
"schema": {
|
|
"type": "array"
|
|
},
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/users/me": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Retrieve the logged in user informations",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Users-PermissionsUser"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"summary": "",
|
|
"tags": [
|
|
"Users-Permissions - User"
|
|
],
|
|
"parameters": []
|
|
}
|
|
},
|
|
"/users/{_id}": {
|
|
"get": {
|
|
"deprecated": false,
|
|
"description": "Retrieve a single user depending on his id",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Users-PermissionsUser"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"summary": "",
|
|
"tags": [
|
|
"Users-Permissions - User"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "_id",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"deprecated": false,
|
|
"description": "Update an existing user",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Users-PermissionsUser"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"summary": "",
|
|
"tags": [
|
|
"Users-Permissions - User"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "_id",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NewUsers-PermissionsUser"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"deprecated": false,
|
|
"description": "Delete an existing user",
|
|
"responses": {
|
|
"200": {
|
|
"description": "response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"summary": "",
|
|
"tags": [
|
|
"Users-Permissions - User"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "_id",
|
|
"in": "path",
|
|
"description": "",
|
|
"deprecated": false,
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"Users-PermissionsUser": {
|
|
"required": [
|
|
"id",
|
|
"username",
|
|
"email"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"minLength": 3
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"minLength": 6
|
|
},
|
|
"provider": {
|
|
"type": "string"
|
|
},
|
|
"confirmed": {
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"blocked": {
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"role": {
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"permissions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"users": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"NewUsers-PermissionsUser": {
|
|
"required": [
|
|
"username",
|
|
"email"
|
|
],
|
|
"properties": {
|
|
"username": {
|
|
"type": "string",
|
|
"minLength": 3
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"minLength": 6
|
|
},
|
|
"provider": {
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"minLength": 6
|
|
},
|
|
"resetPasswordToken": {
|
|
"type": "string"
|
|
},
|
|
"confirmed": {
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"blocked": {
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"name": "Users-Permissions - User"
|
|
}
|
|
]
|
|
} |