Signed-off-by: skjnldsv <skjnldsv@protonmail.com>pull/50123/head
parent
7d8bb60bfe
commit
2c13259093
@ -0,0 +1,473 @@ |
||||
{ |
||||
"openapi": "3.0.3", |
||||
"info": { |
||||
"title": "core-administration", |
||||
"version": "0.0.1", |
||||
"description": "Core functionality of Nextcloud", |
||||
"license": { |
||||
"name": "agpl" |
||||
} |
||||
}, |
||||
"components": { |
||||
"securitySchemes": { |
||||
"basic_auth": { |
||||
"type": "http", |
||||
"scheme": "basic" |
||||
}, |
||||
"bearer_auth": { |
||||
"type": "http", |
||||
"scheme": "bearer" |
||||
} |
||||
}, |
||||
"schemas": { |
||||
"Capabilities": { |
||||
"type": "object", |
||||
"required": [ |
||||
"core" |
||||
], |
||||
"properties": { |
||||
"core": { |
||||
"type": "object", |
||||
"required": [ |
||||
"pollinterval", |
||||
"webdav-root", |
||||
"reference-api", |
||||
"reference-regex", |
||||
"mod-rewrite-working" |
||||
], |
||||
"properties": { |
||||
"pollinterval": { |
||||
"type": "integer", |
||||
"format": "int64" |
||||
}, |
||||
"webdav-root": { |
||||
"type": "string" |
||||
}, |
||||
"reference-api": { |
||||
"type": "boolean" |
||||
}, |
||||
"reference-regex": { |
||||
"type": "string" |
||||
}, |
||||
"mod-rewrite-working": { |
||||
"type": "boolean" |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"OCSMeta": { |
||||
"type": "object", |
||||
"required": [ |
||||
"status", |
||||
"statuscode" |
||||
], |
||||
"properties": { |
||||
"status": { |
||||
"type": "string" |
||||
}, |
||||
"statuscode": { |
||||
"type": "integer" |
||||
}, |
||||
"message": { |
||||
"type": "string" |
||||
}, |
||||
"totalitems": { |
||||
"type": "string" |
||||
}, |
||||
"itemsperpage": { |
||||
"type": "string" |
||||
} |
||||
} |
||||
}, |
||||
"PublicCapabilities": { |
||||
"type": "object", |
||||
"required": [ |
||||
"bruteforce" |
||||
], |
||||
"properties": { |
||||
"bruteforce": { |
||||
"type": "object", |
||||
"required": [ |
||||
"delay", |
||||
"allow-listed" |
||||
], |
||||
"properties": { |
||||
"delay": { |
||||
"type": "integer", |
||||
"format": "int64" |
||||
}, |
||||
"allow-listed": { |
||||
"type": "boolean" |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"paths": { |
||||
"/ocs/v2.php/twofactor/state": { |
||||
"get": { |
||||
"operationId": "two_factor_api-state", |
||||
"summary": "Get two factor authentication provider states", |
||||
"description": "This endpoint requires admin access", |
||||
"tags": [ |
||||
"two_factor_api" |
||||
], |
||||
"security": [ |
||||
{ |
||||
"bearer_auth": [] |
||||
}, |
||||
{ |
||||
"basic_auth": [] |
||||
} |
||||
], |
||||
"parameters": [ |
||||
{ |
||||
"name": "user", |
||||
"in": "query", |
||||
"description": "system user id", |
||||
"required": true, |
||||
"schema": { |
||||
"type": "string" |
||||
} |
||||
}, |
||||
{ |
||||
"name": "OCS-APIRequest", |
||||
"in": "header", |
||||
"description": "Required to be true for the API request to pass", |
||||
"required": true, |
||||
"schema": { |
||||
"type": "boolean", |
||||
"default": true |
||||
} |
||||
} |
||||
], |
||||
"responses": { |
||||
"200": { |
||||
"description": "provider states", |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"ocs" |
||||
], |
||||
"properties": { |
||||
"ocs": { |
||||
"type": "object", |
||||
"required": [ |
||||
"meta", |
||||
"data" |
||||
], |
||||
"properties": { |
||||
"meta": { |
||||
"$ref": "#/components/schemas/OCSMeta" |
||||
}, |
||||
"data": { |
||||
"type": "object", |
||||
"additionalProperties": { |
||||
"type": "boolean" |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"404": { |
||||
"description": "user not found", |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"ocs" |
||||
], |
||||
"properties": { |
||||
"ocs": { |
||||
"type": "object", |
||||
"required": [ |
||||
"meta", |
||||
"data" |
||||
], |
||||
"properties": { |
||||
"meta": { |
||||
"$ref": "#/components/schemas/OCSMeta" |
||||
}, |
||||
"data": { |
||||
"nullable": true |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"/ocs/v2.php/twofactor/enable": { |
||||
"post": { |
||||
"operationId": "two_factor_api-enable", |
||||
"summary": "Enable two factor authentication providers for specific user", |
||||
"description": "This endpoint requires admin access", |
||||
"tags": [ |
||||
"two_factor_api" |
||||
], |
||||
"security": [ |
||||
{ |
||||
"bearer_auth": [] |
||||
}, |
||||
{ |
||||
"basic_auth": [] |
||||
} |
||||
], |
||||
"requestBody": { |
||||
"required": true, |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"user" |
||||
], |
||||
"properties": { |
||||
"user": { |
||||
"type": "string", |
||||
"description": "system user identifier" |
||||
}, |
||||
"providers": { |
||||
"type": "array", |
||||
"default": [], |
||||
"description": "collection of TFA provider ids", |
||||
"items": { |
||||
"type": "string" |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"parameters": [ |
||||
{ |
||||
"name": "OCS-APIRequest", |
||||
"in": "header", |
||||
"description": "Required to be true for the API request to pass", |
||||
"required": true, |
||||
"schema": { |
||||
"type": "boolean", |
||||
"default": true |
||||
} |
||||
} |
||||
], |
||||
"responses": { |
||||
"200": { |
||||
"description": "provider states", |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"ocs" |
||||
], |
||||
"properties": { |
||||
"ocs": { |
||||
"type": "object", |
||||
"required": [ |
||||
"meta", |
||||
"data" |
||||
], |
||||
"properties": { |
||||
"meta": { |
||||
"$ref": "#/components/schemas/OCSMeta" |
||||
}, |
||||
"data": { |
||||
"type": "object", |
||||
"additionalProperties": { |
||||
"type": "boolean" |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"404": { |
||||
"description": "user not found", |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"ocs" |
||||
], |
||||
"properties": { |
||||
"ocs": { |
||||
"type": "object", |
||||
"required": [ |
||||
"meta", |
||||
"data" |
||||
], |
||||
"properties": { |
||||
"meta": { |
||||
"$ref": "#/components/schemas/OCSMeta" |
||||
}, |
||||
"data": { |
||||
"nullable": true |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"/ocs/v2.php/twofactor/disable": { |
||||
"post": { |
||||
"operationId": "two_factor_api-disable", |
||||
"summary": "Disable two factor authentication providers for specific user", |
||||
"description": "This endpoint requires admin access", |
||||
"tags": [ |
||||
"two_factor_api" |
||||
], |
||||
"security": [ |
||||
{ |
||||
"bearer_auth": [] |
||||
}, |
||||
{ |
||||
"basic_auth": [] |
||||
} |
||||
], |
||||
"requestBody": { |
||||
"required": true, |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"user" |
||||
], |
||||
"properties": { |
||||
"user": { |
||||
"type": "string", |
||||
"description": "system user identifier" |
||||
}, |
||||
"providers": { |
||||
"type": "array", |
||||
"default": [], |
||||
"description": "collection of TFA provider ids", |
||||
"items": { |
||||
"type": "string" |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"parameters": [ |
||||
{ |
||||
"name": "OCS-APIRequest", |
||||
"in": "header", |
||||
"description": "Required to be true for the API request to pass", |
||||
"required": true, |
||||
"schema": { |
||||
"type": "boolean", |
||||
"default": true |
||||
} |
||||
} |
||||
], |
||||
"responses": { |
||||
"200": { |
||||
"description": "provider states", |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"ocs" |
||||
], |
||||
"properties": { |
||||
"ocs": { |
||||
"type": "object", |
||||
"required": [ |
||||
"meta", |
||||
"data" |
||||
], |
||||
"properties": { |
||||
"meta": { |
||||
"$ref": "#/components/schemas/OCSMeta" |
||||
}, |
||||
"data": { |
||||
"type": "object", |
||||
"additionalProperties": { |
||||
"type": "boolean" |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"404": { |
||||
"description": "user not found", |
||||
"content": { |
||||
"application/json": { |
||||
"schema": { |
||||
"type": "object", |
||||
"required": [ |
||||
"ocs" |
||||
], |
||||
"properties": { |
||||
"ocs": { |
||||
"type": "object", |
||||
"required": [ |
||||
"meta", |
||||
"data" |
||||
], |
||||
"properties": { |
||||
"meta": { |
||||
"$ref": "#/components/schemas/OCSMeta" |
||||
}, |
||||
"data": { |
||||
"nullable": true |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
} |
||||
}, |
||||
"tags": [ |
||||
{ |
||||
"name": "avatar", |
||||
"description": "Class AvatarController" |
||||
}, |
||||
{ |
||||
"name": "guest_avatar", |
||||
"description": "This controller handles guest avatar requests." |
||||
}, |
||||
{ |
||||
"name": "ocm", |
||||
"description": "Controller about the endpoint /ocm-provider/" |
||||
} |
||||
] |
||||
} |
Loading…
Reference in new issue