getUsersPrefixes
Gets a list of users
Requires authentication as administrator
getUsersPrefixes
Request
get /Users/Prefixes
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 | NameIdPair [] | Operation successful. Returning a NameIdPair[] 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
NameIdPair
see also MediaBrowser.Model.Dto.NameIdPair
| Name | Type | Notes |
|---|---|---|
| Name | string | The name. |
| Id | string | The identifier. |