postUsersByIdPolicy

Updates a user policy

Requires authentication as administrator

Request
post /Users/{Id}/Policy
Parameters
Name In Type Default Notes
*Id path
*body body UserPolicy

UserPolicy:
Responses
Status Code Type Description Samples
200

Operation successful. Empty response.
400

Bad Request. Server cannot process request.
401

Unauthorized. Client needs to authenticate.
403

Forbidden. No permission for the reqested operation.
404

Resource not found or unavailable.
500

Server error.

Definitions

UserPolicy

Name Type Notes
IsAdministrator boolean

A value indicating whether this instance is administrator.
IsHidden boolean

A value indicating whether this instance is hidden.
IsHiddenRemotely boolean
IsHiddenFromUnusedDevices boolean
IsDisabled boolean

A value indicating whether this instance is disabled.
LockedOutDate integer (int64)
MaxParentalRating integer (int32)

The max parental rating.
AllowTagOrRating boolean
BlockedTags array
IsTagBlockingModeInclusive boolean
IncludeTags array
EnableUserPreferenceAccess boolean
AccessSchedules AccessSchedule[]
BlockUnratedItems UnratedItem[]
EnableRemoteControlOfOtherUsers boolean
EnableSharedDeviceControl boolean
EnableRemoteAccess boolean
EnableLiveTvManagement boolean
EnableLiveTvAccess boolean
EnableMediaPlayback boolean
EnableAudioPlaybackTranscoding boolean
EnableVideoPlaybackTranscoding boolean
EnablePlaybackRemuxing boolean
EnableContentDeletion boolean
RestrictedFeatures array
EnableContentDeletionFromFolders array
EnableContentDownloading boolean
EnableSubtitleDownloading boolean
EnableSubtitleManagement boolean
EnableSyncTranscoding boolean

A value indicating whether [enable synchronize].
EnableMediaConversion boolean
EnabledChannels array
EnableAllChannels boolean
EnabledFolders array
EnableAllFolders boolean
InvalidLoginAttemptCount integer (int32)
EnablePublicSharing boolean
RemoteClientBitrateLimit integer (int32)
AuthenticationProviderId string
ExcludedSubFolders array
SimultaneousStreamLimit integer (int32)
EnabledDevices array
EnableAllDevices boolean
AllowCameraUpload boolean
AllowSharingPersonalItems boolean

AccessSchedule

Name Type Notes
DayOfWeek DynamicDayOfWeek
StartHour number (double)

The start hour.
EndHour number (double)

The end hour.

DynamicDayOfWeek

Enum Values
  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Everyday
  • Weekday
  • Weekend

UnratedItem