v1

latestOpenAPI 3.0.3AGPL v3.02026-07-17425785.7 KB
RecipientsService

Update a recipient.

patch/recipients/{name}

Path parameters

namestring required

Name of the recipient.

Request body

namestring required

Name of the recipient.

newNamestring

New name for the recipient

ownerstring

Username of the recipient owner.

commentstring

Description about the recipient.

propertiesobject

Recipient properties as map of string key-value pairs.

When provided in update request, the specified properties will override the existing properties. To add and remove properties, one would need to perform a read-modify-write.

expirationTimestring

Expiration timestamp of the token, in epoch milliseconds.

Response

OK

idstring

Unique ID of the recipient.

namestring

The name of the recipient.

authenticationTypeinteger

The delta sharing authentication type.

ownerstring

Username of the recipient owner.

commentstring

Description about the recipient.

propertiesobject

A map of key-value properties attached to the securable.

createdAtstring

Time at which this share was created, in epoch milliseconds.

createdBystring

Username of the creator of the share.

updatedAtstring

Time at which this share was updated, in epoch milliseconds.

updatedBystring

Username of share updater.