List FPP REST Users
get
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/fppServers/{fppServerId}/restUsers
Lists REST users of an FPP server
Request
Path Parameters
-
fppServerId(required): string
ID of the FPP Server
Query Parameters
-
limit: integer(int32)
Limit count of the items in the responseExample:
10
-
page: string
Marker indicating the next set (page) of itemsExample:
b2Zmc2V0OjA
-
sort: string
Comma separated list of fields along with an optional sort direction. The supported attribute of sorting is 'username'.Valid sort directions are 'asc' and 'desc'. If sort direction is not specified, 'asc' is used by default.Example:
username:asc
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Ok. REST users retrived.
Root Schema : RestUserCollection
Type:
object
List of FPP REST users registered with FPP Server
Show Source
-
items: array
items
Array of REST users
-
targetId: string
ID of the Target
Match All
Show Source
-
object
Pagination
Collection of items with links
-
object
schema
Target details
Nested Schema : Pagination
Type:
object
Collection of items with links
Show Source
-
count: integer
Count of this fetchExample:
40
-
links: object
Links
Represents the array of links
-
total: integer
total countExample:
40
Nested Schema : schema
Type:
object
Target details
Show Source
-
targetName: string
Name of the targetExample:
sales_db1
-
targetType: string
Type of the targetExample:
oracle_database
Nested Schema : items
Type:
object
Match All
Show Source
-
object
CreateRestUserDetails
Details of REST user
Nested Schema : CreateRestUserDetails
Type:
object
Details of REST user
Show Source
-
password(required): string
(password)
Password to create the REST credential in EM, which is required to make a call to the FPP REST URLExample:
welcome1
-
username(required): string
REST username to be registered with the FPP server
Nested Schema : Links
Type:
object
Represents the array of links
Show Source
-
next: object
Link
Represents a link(could be self, previous or next)
-
previous: object
Link
Represents a link(could be self, previous or next)
-
self: object
Link
Represents a link(could be self, previous or next)
Nested Schema : Link
Type:
object
Represents a link(could be self, previous or next)
Show Source
-
href: string
URL for LinkExample:
/em/api/<resources>?page=b2Zmc2V0OjA&limit=0
Examples
400 Response
Bad Request. The payload is null or missing some parameters
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
401 Response
Unauthorized. The user does not have permissions to perform the requested operation
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
403 Response
Forbidden. The user is forbidden to perform the requested operation
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
404 Response
Not Found. The requested REST API URL is not found.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
500 Response
Internal Server Error. Exception in execution of REST API.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
503 Response
Service Unavailable. The server is unable to process the request.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string