A framework for building convergent cross-platform Nextcloud clients using Flutter.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

1385 lines
30 KiB

{
"openapi": "3.1.0",
"info": {
"title": "Provisioning API",
"version": "1.14.0",
"description": "This application enables a set of APIs that external systems can use to manage users, groups and apps.",
"license": {
"name": "agpl",
"identifier": " AGPL-3.0"
}
},
"tags": [
{
"name": "provisioning_api"
}
],
"paths": {
"/ocs/v1.php/apps/provisioning_api/apps": {
"get": {
"operationId": "apps-getapps-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/apps/{app}": {
"parameters": [
{
"name": "app",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"operationId": "apps-getappinfo-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"post": {
"operationId": "apps-enable-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"delete": {
"operationId": "apps-disable-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/groups": {
"get": {
"operationId": "groups-getgroups-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 0
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"post": {
"operationId": "groups-addgroup-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "groupid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "displayname",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/groups/details": {
"get": {
"operationId": "groups-getgroupsdetails-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 0
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/groups/{groupId}/users": {
"parameters": [
{
"name": "groupId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"operationId": "groups-getgroupusers-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/groups/{groupId}/users/details": {
"parameters": [
{
"name": "groupId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"operationId": "groups-getgroupusersdetails-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 0
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/groups/{groupId}/subadmins": {
"parameters": [
{
"name": "groupId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"operationId": "groups-getsubadminsofgroup-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/groups/{groupId}": {
"parameters": [
{
"name": "groupId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"operationId": "groups-getgroup-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"put": {
"operationId": "groups-updategroup-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "value",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"delete": {
"operationId": "groups-deletegroup-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/users": {
"get": {
"operationId": "users-getusers-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 0
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"post": {
"operationId": "users-adduser-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "userid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "password",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "displayName",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "email",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "groups",
"in": "query",
"required": true,
"schema": {
"type": "array"
}
},
{
"name": "subadmin",
"in": "query",
"required": true,
"schema": {
"type": "array"
}
},
{
"name": "quota",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/users/details": {
"get": {
"operationId": "users-getusersdetails-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 0
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/users/search/by-phone": {
"post": {
"operationId": "users-searchbyphonenumbers-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "location",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "search",
"in": "query",
"required": true,
"schema": {
"type": "array"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/users/{userId}": {
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"operationId": "users-getuser-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"put": {
"operationId": "users-edituser-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "value",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"delete": {
"operationId": "users-deleteuser-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/user": {
"get": {
"operationId": "users-getcurrentuser-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/user/fields": {
"get": {
"operationId": "users-geteditablefields-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/user/fields/{userId}": {
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"operationId": "users-geteditablefieldsforuser-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/users/{userId}/{collectionName}": {
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "collectionName",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"put": {
"operationId": "users-editusermultivalue-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "key",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "value",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/users/{userId}/wipe": {
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"operationId": "users-wipeuserdevices-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/users/{userId}/enable": {
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"put": {
"operationId": "users-enableuser-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/users/{userId}/disable": {
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"put": {
"operationId": "users-disableuser-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/users/{userId}/groups": {
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"operationId": "users-getusersgroups-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"post": {
"operationId": "users-addtogroup-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "groupid",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"delete": {
"operationId": "users-removefromgroup-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "groupid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/users/{userId}/subadmins": {
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"operationId": "users-getusersubadmingroups-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"post": {
"operationId": "users-addsubadmin-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "groupid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"delete": {
"operationId": "users-removesubadmin-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "groupid",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/users/{userId}/welcome": {
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"operationId": "users-resendwelcomemessage-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/api/v1/config/apps": {
"get": {
"operationId": "appconfig-getapps-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/api/v1/config/apps/{app}": {
"parameters": [
{
"name": "app",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"operationId": "appconfig-getkeys-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/ocs/v1.php/apps/provisioning_api/api/v1/config/apps/{app}/{key}": {
"parameters": [
{
"name": "app",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"operationId": "appconfig-getvalue-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "defaultValue",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"post": {
"operationId": "appconfig-setvalue-TODO",
"tags": [
"provisioning_api"
],
"parameters": [
{
"name": "value",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"delete": {
"operationId": "appconfig-deletekey-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/apps/provisioning_api/mailVerification/{key}/{token}/{userId}": {
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"operationId": "verification-showverifymail-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"post": {
"operationId": "verification-verifymail-TODO",
"tags": [
"provisioning_api"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
}
}
}