openapi: 3.1.0 info: contact: email: contact@passbolt.com description: This is a low-level overview of the API and its endpoints, if you need higher-level guides for interacting with the endpoints, use the Developer guide. license: name: AGPL-3.0 url: https://www.gnu.org/licenses/agpl-3.0.html termsOfService: https://www.passbolt.com/terms title: Passbolt Authentication (GPGAuth) Authentication (GPGAuth) Folders API version: 5.0.0 servers: - url: https://passbolt.local description: API Passbolt tags: - name: Folders description: Organize your passwords and share them in bulk using folders. paths: /folders.json: get: summary: Get multiple folders. operationId: indexFolders security: - bearerHttpAuthentication: [] x-codeSamples: - lang: cURL source: "curl --request GET \\\n --url {{API_BASE_URL}}/folders.json \\\n --header 'Authorization: Bearer {{JWT_TOKEN}}'\n" - lang: JavaScript source: "const url = '{{API_BASE_URL}}/folders.json';\nconst options = {method: 'GET', headers: {Authorization: 'Bearer {{JWT_TOKEN}}'}};\n\ntry {\n const response = await fetch(url, options);\n const data = await response.json();\n console.log(data);\n} catch (error) {\n console.error(error);\n}\n" - lang: PHP source: " \"{{API_BASE_URL}}/folders.json\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer {{JWT_TOKEN}}\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n" tags: - Folders parameters: - $ref: '#/components/parameters/containChildrenResources' - $ref: '#/components/parameters/containChildrenFolders' - $ref: '#/components/parameters/containCreator' - $ref: '#/components/parameters/containCreatorProfile' - $ref: '#/components/parameters/containModifier' - $ref: '#/components/parameters/containModifierProfile' - $ref: '#/components/parameters/containPermission' - $ref: '#/components/parameters/containPermissions' - $ref: '#/components/parameters/containPermissionsUserProfile' - $ref: '#/components/parameters/containPermissionsGroup' - $ref: '#/components/parameters/filterHasId' - $ref: '#/components/parameters/filterHasParent' - $ref: '#/components/parameters/filterSearch' responses: '200': $ref: '#/components/responses/folders_index' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/authenticationRequired' post: summary: Create a folder. description: '> *Encrypted metadata for this item is not supported on all clients.* ' operationId: addFolder security: - bearerHttpAuthentication: [] x-codeSamples: - lang: cURL source: "curl --request POST \\\n --url {{API_BASE_URL}}/folders.json \\\n --header 'Authorization: Bearer {{JWT_TOKEN}}' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"metadata\": \"-----BEGIN PGP MESSAGE-----\",\n \"metadata_key_id\": \"e3dabc04-cfbd-45c1-9f7d-827c61603e20\",\n \"metadata_key_type\": \"shared_key\"\n }'\n" - lang: JavaScript source: "const url = '{{API_BASE_URL}}/folders.json';\nconst options = {\n method: 'POST',\n headers: {Authorization: 'Bearer {{JWT_TOKEN}}'},\n body: '{\"metadata\": \"-----BEGIN PGP MESSAGE-----\", \"metadata_key_id\": \"e3dabc04-cfbd-45c1-9f7d-827c61603e20\", \"metadata_key_type\": \"shared_key\"}'\n};\n\ntry {\n const response = await fetch(url, options);\n const data = await response.json();\n console.log(data);\n} catch (error) {\n console.error(error);\n}\n" - lang: PHP source: " \"{{API_BASE_URL}}/folders.json\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => json_encode([\n 'metadata' => '-----BEGIN PGP MESSAGE-----',\n 'metadata_key_id' => 'e3dabc04-cfbd-45c1-9f7d-827c61603e20',\n 'metadata_key_type' => 'shared_key'\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer {{JWT_TOKEN}}\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n" tags: - Folders requestBody: $ref: '#/components/requestBodies/folderAdd' parameters: - $ref: '#/components/parameters/containChildrenResources' - $ref: '#/components/parameters/containChildrenFolders' - $ref: '#/components/parameters/containCreator' - $ref: '#/components/parameters/containModifier' - $ref: '#/components/parameters/containPermission' - $ref: '#/components/parameters/containPermissions' - $ref: '#/components/parameters/containPermissionsUserProfile' - $ref: '#/components/parameters/containPermissionsGroup' responses: '200': $ref: '#/components/responses/folders_add' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/authenticationRequired' /folders/{folderId}.json: get: summary: Get a folder. operationId: viewFolder security: - bearerHttpAuthentication: [] x-codeSamples: - lang: cURL source: "curl --request GET \\\n --url {{API_BASE_URL}}/folders/27605bac-8aa8-4fe4-a80b-486d8b76c748.json \\\n --header 'Authorization: Bearer {{JWT_TOKEN}}'\n" - lang: JavaScript source: "const url = '{{API_BASE_URL}}/folders/27605bac-8aa8-4fe4-a80b-486d8b76c748.json';\nconst options = {method: 'GET', headers: {Authorization: 'Bearer {{JWT_TOKEN}}'}};\n\ntry {\n const response = await fetch(url, options);\n const data = await response.json();\n console.log(data);\n} catch (error) {\n console.error(error);\n}\n" - lang: PHP source: " \"{{API_BASE_URL}}/folders/27605bac-8aa8-4fe4-a80b-486d8b76c748.json\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer {{JWT_TOKEN}}\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n" tags: - Folders parameters: - $ref: '#/components/parameters/folderId' - $ref: '#/components/parameters/containChildrenResources' - $ref: '#/components/parameters/containChildrenFolders' - $ref: '#/components/parameters/containCreator' - $ref: '#/components/parameters/containCreatorProfile' - $ref: '#/components/parameters/containModifier' - $ref: '#/components/parameters/containModifierProfile' - $ref: '#/components/parameters/containPermission' - $ref: '#/components/parameters/containPermissions' - $ref: '#/components/parameters/containPermissionsUserProfile' - $ref: '#/components/parameters/containPermissionsGroup' - $ref: '#/components/parameters/filterHasId' responses: '200': $ref: '#/components/responses/folders_view' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/authenticationRequired' '404': $ref: '#/components/responses/notFound' put: summary: Update a folder. description: '> *Encrypted metadata for this item is not supported on all clients.* The current user must have the “update” or “owner” permission on the folder. ' operationId: updateFolder x-codeSamples: - lang: cURL source: "curl --request PUT \\\n --url {{API_BASE_URL}}/folders/27605bac-8aa8-4fe4-a80b-486d8b76c748.json \\\n --header 'Authorization: Bearer {{JWT_TOKEN}}' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"metadata\": \"-----BEGIN PGP MESSAGE-----\",\n \"metadata_key_id\": \"9d9a6672-35d6-4d0f-a807-b90edf25c275\",\n \"metadata_key_type\": \"shared_key\",\n }'\n" - lang: JavaScript source: "const url = '{{API_BASE_URL}}/folders/27605bac-8aa8-4fe4-a80b-486d8b76c748.json';\nconst options = {\n method: 'PUT',\n headers: {Authorization: 'Bearer {{JWT_TOKEN}}'},\n body: '{\"metadata\":\"-----BEGIN PGP MESSAGE-----\",\"metadata_key_id\":\"9d9a6672-35d6-4d0f-a807-b90edf25c275\",\"metadata_key_type\":\"shared_key\"}'\n};\n\ntry {\n const response = await fetch(url, options);\n const data = await response.json();\n console.log(data);\n} catch (error) {\n console.error(error);\n}\n" - lang: PHP source: " \"{{API_BASE_URL}}/folders/27605bac-8aa8-4fe4-a80b-486d8b76c748.json\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"PUT\",\n CURLOPT_POSTFIELDS => json_encode([\n 'metadata' => '-----BEGIN PGP MESSAGE-----',\n 'metadata_key_id' => '9d9a6672-35d6-4d0f-a807-b90edf25c275',\n 'metadata_key_type' => 'shared_key',\n ]),\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer {{JWT_TOKEN}}\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n" security: - bearerHttpAuthentication: [] parameters: - $ref: '#/components/parameters/folderId' - $ref: '#/components/parameters/containChildrenResources' - $ref: '#/components/parameters/containChildrenFolders' - $ref: '#/components/parameters/containCreator' - $ref: '#/components/parameters/containModifier' - $ref: '#/components/parameters/containPermission' - $ref: '#/components/parameters/containPermissions' - $ref: '#/components/parameters/containPermissionsUserProfile' - $ref: '#/components/parameters/containPermissionsGroup' tags: - Folders requestBody: $ref: '#/components/requestBodies/folderUpdate' responses: '200': $ref: '#/components/responses/folders_update' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/authenticationRequired' '404': $ref: '#/components/responses/notFound' delete: summary: Delete a folder. operationId: deleteFolder x-codeSamples: - lang: cURL source: "curl --request DELETE \\\n --url {{API_BASE_URL}}/folders/b2a72cb2-508c-43ad-b96f-697f7ad21635.json \\\n --header 'Authorization: Bearer {{JWT_TOKEN}}'\n" - lang: JavaScript source: "const url = '{{API_BASE_URL}}/folders/b2a72cb2-508c-43ad-b96f-697f7ad21635.json';\nconst options = {method: 'DELETE', headers: {Authorization: 'Bearer {{JWT_TOKEN}}'}};\n\ntry {\n const response = await fetch(url, options);\n const data = await response.json();\n console.log(data);\n} catch (error) {\n console.error(error);\n}\n" - lang: PHP source: " \"{{API_BASE_URL}}/folders/b2a72cb2-508c-43ad-b96f-697f7ad21635.json\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"DELETE\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: Bearer {{JWT_TOKEN}}\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}\n" security: - bearerHttpAuthentication: [] parameters: - $ref: '#/components/parameters/folderId' - $ref: '#/components/parameters/cascade' tags: - Folders responses: '200': $ref: '#/components/responses/nullBody' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/authenticationRequired' '404': $ref: '#/components/responses/notFound' components: schemas: e2eeMetadataBasedId: allOf: - $ref: '#/components/schemas/e2eeMetadataBased' - type: object required: - id properties: id: type: string format: uuid folderV5IndexAndView: allOf: - $ref: '#/components/schemas/e2eeMetadataBasedCommon' - type: object properties: children_resources: type: array items: anyOf: - $ref: '#/components/schemas/resourceV4IndexAndView' - $ref: '#/components/schemas/resourceV5IndexAndView' children_folders: type: array items: anyOf: - $ref: '#/components/schemas/folderV4IndexAndView' - $ref: '#/components/schemas/folderV5IndexAndView' resourceV5IndexAndView: allOf: - $ref: '#/components/schemas/e2eeMetadataBasedCommon' - type: object required: - resource_type_id - expired properties: resource_type_id: type: string format: uuid expired: type: string format: date-time x-nullable: true favorite: $ref: '#/components/schemas/favorite' secrets: type: array items: type: string resource_type: $ref: '#/components/schemas/resourceType' groupsUsersIndexAndView: type: object required: - id - group_id - user_id - is_admin - created properties: id: type: string format: uuid group_id: type: string format: uuid user_id: type: string format: uuid is_admin: type: boolean created: type: string format: date-time user: $ref: '#/components/schemas/userIndexAndView' e2eeMetadataBased: type: object required: - metadata - metadata_key_id - metadata_key_type properties: metadata: type: string metadata_key_id: type: string format: uuid metadata_key_type: type: string enum: - user_key - shared_key secretIndex: type: object required: - id - user_id - resource_id - data - created - modified properties: id: type: string format: uuid user_id: type: string format: uuid resource_id: type: string format: uuid data: type: string created: type: string format: date-time modified: type: string format: date-time userIndexAndView: type: object required: - id - role_id - username - active - deleted - created - modified - disabled properties: is_mfa_enabled: type: boolean id: type: string format: uuid role_id: type: string format: uuid username: type: string active: type: boolean deleted: type: boolean created: type: string format: date-time modified: type: string format: date-time disabled: type: string format: date-time x-nullable: true profile: type: object required: - id - user_id - first_name - last_name - created - modified - avatar properties: id: type: string format: uuid user_id: type: string format: uuid first_name: type: string last_name: type: string created: type: string format: date-time modified: type: string format: date-time avatar: type: object required: - url properties: id: type: string format: uuid profile_id: type: string format: uuid created: type: string format: date-time modified: type: string format: date-time url: type: object required: - medium - small properties: medium: type: string format: url small: type: string format: url groups_users: $ref: '#/components/schemas/groupsUsersIndexAndView' gpgkey: $ref: '#/components/schemas/gpgkey' x-nullable: true role: $ref: '#/components/schemas/role' missing_metadata_key_ids: type: array items: type: string format: uuid last_logged_in: type: string format: date-time x-nullable: true groupIndexAndView: type: object required: - id - name - deleted - created - modified - created_by - modified_by properties: id: type: string format: uuid name: type: string deleted: type: boolean created: type: string format: date-time modified: type: string format: date-time created_by: type: string format: uuid modified_by: type: string format: uuid my_group_user: $ref: '#/components/schemas/groupsUsersIndexAndView' groups_users: type: array items: $ref: '#/components/schemas/groupsUsersIndexAndView' user_count: type: integer e2eeMetadataBasedCommon: allOf: - $ref: '#/components/schemas/e2eeMetadataBasedId' - type: object required: - created - modified - created_by - modified_by - personal - folder_parent_id properties: created: type: string format: date-time modified: type: string format: date-time created_by: type: string format: uuid modified_by: type: string format: uuid personal: type: boolean folder_parent_id: type: string format: uuid x-nullable: true modifier: $ref: '#/components/schemas/userIndexAndView' creator: $ref: '#/components/schemas/userIndexAndView' permission: $ref: '#/components/schemas/permissionIndexAndView' permissions: type: array items: $ref: '#/components/schemas/permissionIndexAndView' headerWithPagination: type: object required: - id - status - servertime - action - message - url - code - pagination properties: id: type: string format: uuid status: type: string enum: - success - error servertime: type: integer example: 1720702619 action: type: string format: uuid message: type: string example: The operation was successful. url: type: string format: uri example: /auth/verify.json code: type: integer example: 200 pagination: type: object required: - count - page - limit properties: count: type: integer page: type: integer limit: type: integer x-nullable: true resourceV4IndexAndView: type: object required: - id - name - username - uri - description - deleted - created - created_by - modified_by - resource_type_id - expired - folder_parent_id - personal properties: id: type: string format: uuid name: type: string username: type: string uri: type: string description: type: string deleted: type: boolean created: type: string format: date-time created_by: type: string format: uuid modified_by: type: string format: uuid resource_type_id: type: string format: uuid expired: type: string format: date-time x-nullable: true folder_parent_id: type: string format: uuid x-nullable: true personal: type: boolean favorite: $ref: '#/components/schemas/favorite' modifier: $ref: '#/components/schemas/userIndexAndView' creator: $ref: '#/components/schemas/userIndexAndView' secrets: type: array items: $ref: '#/components/schemas/secretIndex' resource_type: $ref: '#/components/schemas/resourceType' permission: $ref: '#/components/schemas/permissionIndexAndView' permissions: type: array items: $ref: '#/components/schemas/permissionIndexAndView' gpgkey: type: object required: - id - user_id - armored_key - bits - uid - key_id - fingerprint - type - expires - key_created - deleted - created - modified properties: id: type: string format: uuid user_id: type: string format: uuid armored_key: type: string bits: type: integer uid: type: string key_id: type: string fingerprint: type: string type: type: string enum: - RSA - ECC expires: type: string format: date-time x-nullable: true deleted: type: boolean created: type: string format: date-time modified: type: string format: date-time permissionIndexAndView: type: object required: - id - aco - aco_foreign_key - aro - aro_foreign_key - type - created - modified properties: id: type: string format: uuid aco: type: string enum: - Resource - Folder aco_foreign_key: type: string format: uuid aro: type: string enum: - User - Group aro_foreign_key: type: string format: uuid type: $ref: '#/components/schemas/permissionLevel' created: type: string format: date-time modified: type: string format: date-time user: $ref: '#/components/schemas/userIndexAndView' x-nullable: true group: $ref: '#/components/schemas/groupIndexAndView' x-nullable: true permissionLevel: description: '* `1` - Read * `7` - Update * `15` - Owner ' type: integer enum: - 1 - 7 - 15 resourceType: type: object required: - id - slug - name - description - definition - deleted - created - modified properties: id: type: string format: uuid slug: type: string description: '* `password-string` - The original passbolt resource type, where the secret is a non empty string. * `password-and-description` - A resource with the password and the description encrypted. * `totp` - A resource with standalone TOTP fields. * `password-description-totp` - A resource with encrypted password, description and TOTP fields. * `v5-default-with-totp` - The new default resource type with a TOTP introduced with v5. * `v5-password-string (Deprecated)` - The original passbolt resource type, kept for backward compatibility reasons. * `v5-totp-standalone` - The new standalone TOTP resource type introduced with v5. * `v5-default` - The new default resource type introduced with v5. ' enum: - password-string - password-and-description - totp - password-description-totp - v5-default-with-totp - v5-password-string (Deprecated) - v5-totp-standalone - v5-default name: type: string description: type: string definition: type: object description: Schema for the expected data for this kind of resources. deleted: type: string x-nullable: true created: type: string format: date-time modified: type: string format: date-time role: type: object required: - id - name - description - created - modified properties: id: type: string format: uuid name: type: string enum: - admin - guest - user description: type: string created: type: string format: date-time modified: type: string format: date-time favorite: type: object required: - id - user_id - foreign_key - foreign_model - created - modified properties: id: type: string format: uuid user_id: type: string format: uuid foreign_key: type: string format: uuid foreign_model: type: string enum: - Resource created: type: string format: date-time modified: type: string format: date-time header: type: object required: - id - status - servertime - action - message - url - code properties: id: type: string format: uuid status: type: string enum: - success - error servertime: type: integer example: 1720702619 action: type: string format: uuid message: type: string example: The operation was successful. url: type: string format: uri example: /auth/verify.json code: type: integer example: 200 folderV4IndexAndView: type: object required: - id - name - created - modified - created_by - modified_by - folder_parent_id - personal properties: id: type: string format: uuid name: type: string created: type: string format: date-time modified: type: string format: date-time created_by: type: string format: uuid modified_by: type: string format: uuid folder_parent_id: type: string format: uuid x-nullable: true personal: type: boolean modifier: $ref: '#/components/schemas/userIndexAndView' creator: $ref: '#/components/schemas/userIndexAndView' permission: $ref: '#/components/schemas/permissionIndexAndView' permissions: type: array items: $ref: '#/components/schemas/permissionIndexAndView' children_resources: type: array items: anyOf: - $ref: '#/components/schemas/resourceV4IndexAndView' - $ref: '#/components/schemas/resourceV5IndexAndView' children_folders: type: array items: anyOf: - $ref: '#/components/schemas/folderV4IndexAndView' - $ref: '#/components/schemas/folderV5IndexAndView' responses: folders_update: description: Operation is successful content: application/json: schema: type: object required: - header - body properties: header: $ref: '#/components/schemas/header' body: $ref: '#/components/schemas/folderV5IndexAndView' examples: index: value: header: id: 7ff2828c-1092-4897-8e0a-1dc64ada889f status: success servertime: 1721207029 action: 4d0c0996-ce30-4bce-9918-9062ab35c542 message: The operation was successful. url: /folders/27605bac-8aa8-4fe4-a80b-486d8b76c748.json code: 200 body: id: 27605bac-8aa8-4fe4-a80b-486d8b76c748 metadata: '-----BEGIN PGP MESSAGE-----' metadata_key_id: dd1f723d-0d1e-513f-8218-4055dc0530d0 metadata_key_type: shared_key created: '2025-02-19T13:50:53+00:00' modified: '2025-02-19T13:50:53+00:00' created_by: ae48ed02-54ea-4be4-9ae8-229bf8c04739 modified_by: ae48ed02-54ea-4be4-9ae8-229bf8c04739 folder_parent_id: null personal: true folders_view: description: Operation is successful content: application/json: schema: type: object required: - header - body properties: header: $ref: '#/components/schemas/header' body: anyOf: - $ref: '#/components/schemas/folderV4IndexAndView' - $ref: '#/components/schemas/folderV5IndexAndView' examples: index: value: header: id: 7ff2828c-1092-4897-8e0a-1dc64ada889f status: success servertime: 1721207029 action: 4d0c0996-ce30-4bce-9918-9062ab35c542 message: The operation was successful. url: /folders/27605bac-8aa8-4fe4-a80b-486d8b76c748.json code: 200 body: id: 27605bac-8aa8-4fe4-a80b-486d8b76c748 metadata: '-----BEGIN PGP MESSAGE-----' metadata_key_id: dd1f723d-0d1e-513f-8218-4055dc0530d0 metadata_key_type: shared_key created: '2025-02-19T13:50:53+00:00' modified: '2025-02-19T13:50:53+00:00' created_by: ae48ed02-54ea-4be4-9ae8-229bf8c04739 modified_by: ae48ed02-54ea-4be4-9ae8-229bf8c04739 folder_parent_id: null personal: true nullBody: description: Operation is successful. content: application/json: schema: type: object required: - header - body properties: header: $ref: '#/components/schemas/header' body: type: 'null' examples: base: value: header: id: f7be85c0-afb1-4d8e-a9e1-e05abb0bb71a status: success servertime: 1721727753 action: e2aa01a9-84ec-55f8-aaed-24ee23259339 message: url: code: 200 body: null folders_add: description: Operation is successful content: application/json: schema: type: object required: - header - body properties: header: $ref: '#/components/schemas/header' body: $ref: '#/components/schemas/folderV5IndexAndView' examples: index: value: header: id: 7ff2828c-1092-4897-8e0a-1dc64ada889f status: success servertime: 1721207029 action: 4d0c0996-ce30-4bce-9918-9062ab35c542 message: The operation was successful. url: /folders/27605bac-8aa8-4fe4-a80b-486d8b76c748.json code: 200 body: id: 27605bac-8aa8-4fe4-a80b-486d8b76c748 metadata: '-----BEGIN PGP MESSAGE-----' metadata_key_id: dd1f723d-0d1e-513f-8218-4055dc0530d0 metadata_key_type: shared_key created: '2025-02-19T13:50:53+00:00' modified: '2025-02-19T13:50:53+00:00' created_by: ae48ed02-54ea-4be4-9ae8-229bf8c04739 modified_by: ae48ed02-54ea-4be4-9ae8-229bf8c04739 folder_parent_id: null personal: true authenticationRequired: description: Authentication required. content: application/json: schema: type: object required: - header - body properties: header: $ref: '#/components/schemas/header' body: type: string examples: base: value: header: id: f7be85c0-afb1-4d8e-a9e1-e05abb0bb71a status: error servertime: 1721727753 action: e2aa01a9-84ec-55f8-aaed-24ee23259339 message: Authentication is required to continue. url: code: 401 body: '' folders_index: description: Operation is successful content: application/json: schema: type: object required: - header - body properties: header: $ref: '#/components/schemas/headerWithPagination' body: type: array items: anyOf: - $ref: '#/components/schemas/folderV4IndexAndView' - $ref: '#/components/schemas/folderV5IndexAndView' examples: index: value: header: id: 7ff2828c-1092-4897-8e0a-1dc64ada889f status: success servertime: 1721207029 action: 4d0c0996-ce30-4bce-9918-9062ab35c542 message: The operation was successful. url: /folders.json code: 200 pagination: count: 2 page: 1 limit: null body: - id: 162e4717-59a2-439b-86c6-fc651e989939 name: Bob created: '2024-07-08T10:13:20+00:00' modified: '2024-07-08T10:13:20+00:00' created_by: 8bb80df5-700c-48ce-b568-85a60fc3c8f2 modified_by: 8bb80df5-700c-48ce-b568-85a60fc3c8f2 folder_parent_id: null personal: true - id: 9eb60ab8-afb9-4daa-bd38-35c7926da577 metadata: '-----BEGIN PGP MESSAGE-----' metadata_key_id: cc8140b3-6ecb-40b5-a977-a5eece53806c metadata_key_type: shared_key created: '2021-04-30T05:56:06+00:00' modified: '2021-04-30T05:56:06+00:00' created_by: f848277c-5398-58f8-a82a-72397af2d450 modified_by: f848277c-5398-58f8-a82a-72397af2d450 folder_parent_id: null personal: true badRequest: description: Bad request content: application/json: schema: type: object required: - header - body properties: header: $ref: '#/components/schemas/header' body: type: string examples: example: value: header: id: 7ff2828c-1092-4897-8e0a-1dc64ada889f status: error servertime: 1721207029 action: 4d0c0996-ce30-4bce-9918-9062ab35c542 message: url: code: 400 body: '' notFound: description: Not found content: application/json: schema: type: object required: - header - body properties: header: $ref: '#/components/schemas/header' body: type: string examples: example: value: header: id: 7ff2828c-1092-4897-8e0a-1dc64ada889f status: error servertime: 1721207029 action: 4d0c0996-ce30-4bce-9918-9062ab35c542 message: The does not exist. url: code: 404 body: '' requestBodies: folderAdd: description: The folder you want to create required: true content: application/json: schema: $ref: '#/components/schemas/e2eeMetadataBased' examples: without_parent: summary: Without a parent folder. value: metadata: '-----BEGIN PGP MESSAGE-----' metadata_key_id: e3dabc04-cfbd-45c1-9f7d-827c61603e20 metadata_key_type: shared_key with_parent: summary: With a parent folder. value: metadata: '-----BEGIN PGP MESSAGE-----' metadata_key_id: e3dabc04-cfbd-45c1-9f7d-827c61603e20 metadata_key_type: shared_key folder_parent_id: 3a003c3e-d000-4068-a6cf-96e15a41e18f folderUpdate: description: The folder you want to update required: true content: application/json: schema: $ref: '#/components/schemas/e2eeMetadataBased' examples: without_parent: value: metadata: '----BEGIN PGP MESSAGE-----' metadata_key_id: 9d9a6672-35d6-4d0f-a807-b90edf25c275 metadata_key_type: shared_key parameters: cascade: name: cascade description: Delete element and its children elements. in: query required: false schema: type: integer enum: - 1 - 0 containModifierProfile: name: contain[modifier.profile] description: Add modifier and their profile to response body. in: query required: false schema: type: integer enum: - 1 - 0 filterHasParent: name: filter[has-parent] description: Only return elements filtered by parent folder. in: query required: false schema: type: string format: uuid containChildrenFolders: name: contain[children_folders] description: Add children folders to response body. in: query required: false schema: type: integer enum: - 1 - 0 filterHasId: name: filter[has-id] description: Only return elements filtered by their id. in: query required: false schema: type: string format: uuid containPermissionsGroup: name: contain[permissions.group] description: Add group to permissions in response body. in: query required: false schema: type: integer enum: - 1 - 0 containChildrenResources: name: contain[children_resources] description: Add children resources to response body. in: query required: false schema: type: integer enum: - 1 - 0 containCreator: name: contain[creator] description: Add creator to response body. in: query required: false schema: type: integer enum: - 1 - 0 containPermissions: name: contain[permissions] description: Add permissions to response body. in: query required: false schema: type: integer enum: - 1 - 0 folderId: name: folderId description: ID for the folder being manipulated. in: path required: true schema: type: string format: uuid containModifier: name: contain[modifier] description: Add modifier to response body. in: query required: false schema: type: integer enum: - 1 - 0 containPermissionsUserProfile: name: contain[permissions.user.profile] description: Add user profile to permissions in response body. in: query required: false schema: type: integer enum: - 1 - 0 containCreatorProfile: name: contain[creator.profile] description: Add creator and their profile to response body. in: query required: false schema: type: integer enum: - 1 - 0 containPermission: name: contain[permission] description: Add permission to response body. in: query required: false schema: type: integer enum: - 1 - 0 filterSearch: name: filter[search] description: Filter using a keyword or a string. in: query required: false schema: type: string securitySchemes: bearerHttpAuthentication: description: Bearer token using a JWT type: http scheme: Bearer bearerFormat: JWT gpgCookieAuthentication: description: Session-based authentication. Note that a CSRF token needs to be provided through a header named `X-CSRF-Token`. type: apiKey in: cookie name: passbolt_session