|
|
|
@ -772,6 +772,88 @@ |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"/ocs/v2.php/cloud/groups": { |
|
|
|
|
"post": { |
|
|
|
|
"operationId": "groups-add-group", |
|
|
|
|
"summary": "Create a new group", |
|
|
|
|
"description": "This endpoint requires admin access\nThis endpoint requires password confirmation", |
|
|
|
|
"tags": [ |
|
|
|
|
"groups" |
|
|
|
|
], |
|
|
|
|
"security": [ |
|
|
|
|
{ |
|
|
|
|
"bearer_auth": [] |
|
|
|
|
}, |
|
|
|
|
{ |
|
|
|
|
"basic_auth": [] |
|
|
|
|
} |
|
|
|
|
], |
|
|
|
|
"requestBody": { |
|
|
|
|
"required": true, |
|
|
|
|
"content": { |
|
|
|
|
"application/json": { |
|
|
|
|
"schema": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"groupid" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"groupid": { |
|
|
|
|
"type": "string", |
|
|
|
|
"description": "ID of the group" |
|
|
|
|
}, |
|
|
|
|
"displayname": { |
|
|
|
|
"type": "string", |
|
|
|
|
"default": "", |
|
|
|
|
"description": "Display name of the group" |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"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": "Group created successfully", |
|
|
|
|
"content": { |
|
|
|
|
"application/json": { |
|
|
|
|
"schema": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"ocs" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"ocs": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"meta", |
|
|
|
|
"data" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"meta": { |
|
|
|
|
"$ref": "#/components/schemas/OCSMeta" |
|
|
|
|
}, |
|
|
|
|
"data": {} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"get": { |
|
|
|
|
"operationId": "groups-get-groups", |
|
|
|
|
"summary": "Get a list of groups", |
|
|
|
@ -873,6 +955,166 @@ |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"/ocs/v2.php/cloud/groups/{groupId}": { |
|
|
|
|
"put": { |
|
|
|
|
"operationId": "groups-update-group", |
|
|
|
|
"summary": "Update a group", |
|
|
|
|
"description": "This endpoint requires admin access\nThis endpoint requires password confirmation", |
|
|
|
|
"tags": [ |
|
|
|
|
"groups" |
|
|
|
|
], |
|
|
|
|
"security": [ |
|
|
|
|
{ |
|
|
|
|
"bearer_auth": [] |
|
|
|
|
}, |
|
|
|
|
{ |
|
|
|
|
"basic_auth": [] |
|
|
|
|
} |
|
|
|
|
], |
|
|
|
|
"requestBody": { |
|
|
|
|
"required": true, |
|
|
|
|
"content": { |
|
|
|
|
"application/json": { |
|
|
|
|
"schema": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"key", |
|
|
|
|
"value" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"key": { |
|
|
|
|
"type": "string", |
|
|
|
|
"description": "Key to update, only 'displayname'" |
|
|
|
|
}, |
|
|
|
|
"value": { |
|
|
|
|
"type": "string", |
|
|
|
|
"description": "New value for the key" |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"parameters": [ |
|
|
|
|
{ |
|
|
|
|
"name": "groupId", |
|
|
|
|
"in": "path", |
|
|
|
|
"description": "ID of the group", |
|
|
|
|
"required": true, |
|
|
|
|
"schema": { |
|
|
|
|
"type": "string", |
|
|
|
|
"pattern": "^.+$" |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
{ |
|
|
|
|
"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": "Group updated successfully", |
|
|
|
|
"content": { |
|
|
|
|
"application/json": { |
|
|
|
|
"schema": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"ocs" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"ocs": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"meta", |
|
|
|
|
"data" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"meta": { |
|
|
|
|
"$ref": "#/components/schemas/OCSMeta" |
|
|
|
|
}, |
|
|
|
|
"data": {} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"delete": { |
|
|
|
|
"operationId": "groups-delete-group", |
|
|
|
|
"summary": "Delete a group", |
|
|
|
|
"description": "This endpoint requires admin access\nThis endpoint requires password confirmation", |
|
|
|
|
"tags": [ |
|
|
|
|
"groups" |
|
|
|
|
], |
|
|
|
|
"security": [ |
|
|
|
|
{ |
|
|
|
|
"bearer_auth": [] |
|
|
|
|
}, |
|
|
|
|
{ |
|
|
|
|
"basic_auth": [] |
|
|
|
|
} |
|
|
|
|
], |
|
|
|
|
"parameters": [ |
|
|
|
|
{ |
|
|
|
|
"name": "groupId", |
|
|
|
|
"in": "path", |
|
|
|
|
"description": "ID of the group", |
|
|
|
|
"required": true, |
|
|
|
|
"schema": { |
|
|
|
|
"type": "string", |
|
|
|
|
"pattern": "^.+$" |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
{ |
|
|
|
|
"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": "Group deleted successfully", |
|
|
|
|
"content": { |
|
|
|
|
"application/json": { |
|
|
|
|
"schema": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"ocs" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"ocs": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"meta", |
|
|
|
|
"data" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"meta": { |
|
|
|
|
"$ref": "#/components/schemas/OCSMeta" |
|
|
|
|
}, |
|
|
|
|
"data": {} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"get": { |
|
|
|
|
"operationId": "groups-get-group", |
|
|
|
|
"summary": "Get a list of users in the specified group", |
|
|
|
@ -1510,6 +1752,269 @@ |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"/ocs/v2.php/apps/provisioning_api/api/v1/config/apps/{app}/{key}": { |
|
|
|
|
"get": { |
|
|
|
|
"operationId": "app_config-get-value", |
|
|
|
|
"summary": "Get a the config value of an app", |
|
|
|
|
"description": "This endpoint requires admin access", |
|
|
|
|
"tags": [ |
|
|
|
|
"app_config" |
|
|
|
|
], |
|
|
|
|
"security": [ |
|
|
|
|
{ |
|
|
|
|
"bearer_auth": [] |
|
|
|
|
}, |
|
|
|
|
{ |
|
|
|
|
"basic_auth": [] |
|
|
|
|
} |
|
|
|
|
], |
|
|
|
|
"parameters": [ |
|
|
|
|
{ |
|
|
|
|
"name": "app", |
|
|
|
|
"in": "path", |
|
|
|
|
"description": "ID of the app", |
|
|
|
|
"required": true, |
|
|
|
|
"schema": { |
|
|
|
|
"type": "string" |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
{ |
|
|
|
|
"name": "key", |
|
|
|
|
"in": "path", |
|
|
|
|
"description": "Key", |
|
|
|
|
"required": true, |
|
|
|
|
"schema": { |
|
|
|
|
"type": "string" |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
{ |
|
|
|
|
"name": "defaultValue", |
|
|
|
|
"in": "query", |
|
|
|
|
"description": "Default returned value if the value is empty", |
|
|
|
|
"schema": { |
|
|
|
|
"type": "string", |
|
|
|
|
"default": "" |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
{ |
|
|
|
|
"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": "Value returned", |
|
|
|
|
"content": { |
|
|
|
|
"application/json": { |
|
|
|
|
"schema": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"ocs" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"ocs": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"meta", |
|
|
|
|
"data" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"meta": { |
|
|
|
|
"$ref": "#/components/schemas/OCSMeta" |
|
|
|
|
}, |
|
|
|
|
"data": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"data" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"data": { |
|
|
|
|
"type": "string" |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"403": { |
|
|
|
|
"description": "App is not allowed", |
|
|
|
|
"content": { |
|
|
|
|
"application/json": { |
|
|
|
|
"schema": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"ocs" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"ocs": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"meta", |
|
|
|
|
"data" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"meta": { |
|
|
|
|
"$ref": "#/components/schemas/OCSMeta" |
|
|
|
|
}, |
|
|
|
|
"data": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"data" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"data": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"message" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"message": { |
|
|
|
|
"type": "string" |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"delete": { |
|
|
|
|
"operationId": "app_config-delete-key", |
|
|
|
|
"summary": "Delete a config key of an app", |
|
|
|
|
"description": "This endpoint requires admin access\nThis endpoint requires password confirmation", |
|
|
|
|
"tags": [ |
|
|
|
|
"app_config" |
|
|
|
|
], |
|
|
|
|
"security": [ |
|
|
|
|
{ |
|
|
|
|
"bearer_auth": [] |
|
|
|
|
}, |
|
|
|
|
{ |
|
|
|
|
"basic_auth": [] |
|
|
|
|
} |
|
|
|
|
], |
|
|
|
|
"parameters": [ |
|
|
|
|
{ |
|
|
|
|
"name": "app", |
|
|
|
|
"in": "path", |
|
|
|
|
"description": "ID of the app", |
|
|
|
|
"required": true, |
|
|
|
|
"schema": { |
|
|
|
|
"type": "string" |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
{ |
|
|
|
|
"name": "key", |
|
|
|
|
"in": "path", |
|
|
|
|
"description": "Key to delete", |
|
|
|
|
"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": "Key deleted successfully", |
|
|
|
|
"content": { |
|
|
|
|
"application/json": { |
|
|
|
|
"schema": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"ocs" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"ocs": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"meta", |
|
|
|
|
"data" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"meta": { |
|
|
|
|
"$ref": "#/components/schemas/OCSMeta" |
|
|
|
|
}, |
|
|
|
|
"data": {} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"403": { |
|
|
|
|
"description": "App or key is not allowed", |
|
|
|
|
"content": { |
|
|
|
|
"application/json": { |
|
|
|
|
"schema": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"ocs" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"ocs": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"meta", |
|
|
|
|
"data" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"meta": { |
|
|
|
|
"$ref": "#/components/schemas/OCSMeta" |
|
|
|
|
}, |
|
|
|
|
"data": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"data" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"data": { |
|
|
|
|
"type": "object", |
|
|
|
|
"required": [ |
|
|
|
|
"message" |
|
|
|
|
], |
|
|
|
|
"properties": { |
|
|
|
|
"message": { |
|
|
|
|
"type": "string" |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
}, |
|
|
|
|
"post": { |
|
|
|
|
"operationId": "app_config-set-value", |
|
|
|
|
"summary": "Update the config value of an app", |
|
|
|
|