Update a resource.

If the password you are updating has been shared with 7 users, the secrets key will need to be an array of 7 objects.

You must encrypt and sign the new plaintext passwords using the recipient public key and the current user secret key. You can then create a list which include one object per user: the data key holds the encrypted plaintext password and user_id holds the user UUID.

put/resources/{resourceId}.json

Request

Base URL
https://passbolt.local
Auth
HTTP bearer
TypeScript
https://skmtc.dev/passbolt/apis/passbolt-api/docs/resources/:resourceId.json/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

resourceIdstring uuid required

ID for the resource being manipulated.

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

expiredstring date-time required

folder_parent_idstring uuid required

resource_type_idstring uuid required

Response

Operation is successful

Changes

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