PApassbolt
Folders

Update a folder.

Encrypted metadata for this item is not supported on all clients.

The current user must have the “update” or “owner” permission on the folder.

put/folders/{folderId}.json

Request

Path parameters

folderIdstring uuid required

ID for the folder being manipulated.

Query parameters

contain[children_resources]1 | 0

Add children resources to response body.

contain[children_folders]1 | 0

Add children folders to response body.

contain[creator]1 | 0

Add creator to response body.

contain[modifier]1 | 0

Add modifier to response body.

contain[permission]1 | 0

Add permission to response body.

contain[permissions]1 | 0

Add permissions to response body.

contain[permissions.user.profile]1 | 0

Add user profile to permissions in response body.

contain[permissions.group]1 | 0

Add group to permissions in response body.

Request body

metadatastring required

An armoured OpenPGP message. Its cleartext is a JSON object carrying an object_type field that names the payload, PASSBOLT_RESOURCE_METADATA for a resource, and the descriptive fields that used to travel in clear in the v4 format. The fields expected for a resource, and the two decryption paths, are described in the guide on working with v5 encrypted metadata.

metadata_key_idstring uuid required
metadata_key_type'user_key' | 'shared_key' required

Response

Operation is successful

Changes

No recorded changes to this operation across all 1 revision of this API.