getUsersQuery

Gets a list of users

Requires authentication as administrator

Request
get /Users/Query
Parameters
Name In Type Default Notes
IsHidden query

Optional filter by IsHidden=true or false
IsDisabled query

Optional filter by IsDisabled=true or false
StartIndex query

Optional. The record index to start at. All items with a lower index will be dropped from the results.
Limit query

Optional. The maximum number of records to return
NameStartsWithOrGreater query

Optional filter by items whose name is sorted equally or greater than a given input string.
SortOrder query

Sort Order - Ascending,Descending
Responses
Status Code Type Description Samples
200 QueryResult_UserDto

Operation successful. Returning a QueryResult object.
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

QueryResult_UserDto

QueryResult_UserDto
Name Type Notes
Items UserDto[]
TotalRecordCount integer (int32)

UserDto

Name Type Notes
Name string

The name.
ServerId string

The server identifier.
ServerName string

The name of the server. This is not used by the server and is for client-side usage only.
Prefix string
ConnectUserName string

The name of the connect user.
DateCreated string (date-time)
ConnectLinkType UserLinkType
Id string

The id.
PrimaryImageTag string

The primary image tag.
HasPassword boolean

A value indicating whether this instance has password.
HasConfiguredPassword boolean

A value indicating whether this instance has configured password.
EnableAutoLogin boolean
LastLoginDate string (date-time)

The last login date.
LastActivityDate string (date-time)

The last activity date.
Configuration UserConfiguration[]

Class UserConfiguration
Policy UserPolicy[]
PrimaryImageAspectRatio number (double)

The primary image aspect ratio.
UserItemShareLevel UserItemShareLevel

UserLinkType

Enum Values
  • LinkedUser
  • Guest

UserConfiguration

Name Type Notes
AudioLanguagePreference string

The audio language preference.
PlayDefaultAudioTrack boolean

A value indicating whether [play default audio track].
SubtitleLanguagePreference string

The subtitle language preference.
ProfilePin string
DisplayMissingEpisodes boolean
SubtitleMode SubtitlePlaybackMode
OrderedViews array
LatestItemsExcludes array
MyMediaExcludes array
HidePlayedInLatest boolean
HidePlayedInMoreLikeThis boolean
HidePlayedInSuggestions boolean
RememberAudioSelections boolean
RememberSubtitleSelections boolean
EnableNextEpisodeAutoPlay boolean
ResumeRewindSeconds integer (int32)
IntroSkipMode SegmentSkipMode
EnableLocalPassword boolean

SubtitlePlaybackMode

Enum Values
  • Default
  • Always
  • OnlyForced
  • None
  • Smart
  • HearingImpaired

SegmentSkipMode

Enum Values
  • ShowButton
  • AutoSkip
  • None

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
EnableTranscodingQuality 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

UserItemShareLevel

Enum Values
  • None
  • Read
  • Write
  • Manage
  • ManageDelete