Shares

Update a share

Updates a share by completely replacing it with specified values.

put/shares/{shareId}

Request

  • Base URL: http://example.com/authorization
  • URL: http://example.com/authorization/shares/{shareId}
  • Auth: none declared. Required headers: If-Match

Path parameters

shareIdstring required

The ID of the share to update.

Query parameters

validateSharedWithboolean

If true, the share recipient specified in the request body will be validated.

Headers

If-Matchstring required

The entity tag obtained from the most recent ETag response header. Must match the current entity tag for the share.

Request body

sharedWithstring required

The principal name of the share recipient.

resourceUristring required

A relative URI that represents a resource. All shares must target a resource URI.

namestring

The user-friendly name of the shared resource.

sharedWithType'user' | 'group' | 'authenticatedUsers' | 'everyone' | 'guest' required

The type of principal to which the share applies.

type'read' | 'readEdit' | 'readShare' | 'readEditShare' required

The level of access that the share provides.

enabledboolean

Flag indicating whether the current share is in effect or not.

versioninteger

The version of the share representation. The current representation version is 2.

Response

The request succeeded. Returned if the object was updated.

sharedWithstring required

The principal name of the share recipient.

resourceUristring required

A relative URI that represents a resource. All shares must target a resource URI.

namestring

The user-friendly name of the shared resource.

sharedWithType'user' | 'group' | 'authenticatedUsers' | 'everyone' | 'guest' required

The type of principal to which the share applies.

type'read' | 'readEdit' | 'readShare' | 'readEditShare' required

The level of access that the share provides.

enabledboolean

Flag indicating whether the current share is in effect or not.

versioninteger

The version of the share representation. The current representation version is 2.

idstring

The unique identifier for the share.

createdBystring

The ID of the user who created the share.

creationTimeStampstring date-time

The date and time at which the share was created.

modifiedBystring

The ID of the last user to modify the share.

modifiedTimeStampstring date-time

The date and time at which the share was last modified.

Changes

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