Jump to

• Request
• Response

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 response

  Example:

  10

• page: string
  Marker indicating the next set (page) of items

  Example:

  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 Top

Response

Supported Media Types

• application/json

200 Response

Ok. REST users retrived.

Body ()

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

{
    "description":"List of FPP REST users registered with FPP Server",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Pagination"
        },
        {
            "$ref":"#/components/schemas/Target"
        }
    ],
    "properties":{
        "targetId":{
            "description":"ID of the Target",
            "type":"string"
        },
        "items":{
            "description":"Array of REST users",
            "type":"array",
            "items":{
                "type":"object",
                "allOf":[
                    {
                        "$ref":"#/components/schemas/CreateRestUserDetails"
                    }
                ]
            }
        }
    }
}

Match All

List of FPP REST users registered with FPP Server

List of FPP REST users registered with FPP Server

Show Source

• object Pagination
  Collection of items with links
• object schema
  Target details

{
    "description":"List of FPP REST users registered with FPP Server",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Pagination"
        },
        {
            "$ref":"#/components/schemas/Target"
        }
    ],
    "properties":{
        "targetId":{
            "description":"ID of the Target",
            "type":"string"
        },
        "items":{
            "description":"Array of REST users",
            "type":"array",
            "items":{
                "type":"object",
                "allOf":[
                    {
                        "$ref":"#/components/schemas/CreateRestUserDetails"
                    }
                ]
            }
        }
    }
}

Nested Schema : items

Type: array

Array of REST users

Show Source

• Array of: object items

{
    "description":"Array of REST users",
    "type":"array",
    "items":{
        "type":"object",
        "allOf":[
            {
                "$ref":"#/components/schemas/CreateRestUserDetails"
            }
        ]
    }
}

Nested Schema : Pagination

Type: object

Collection of items with links

Show Source

• count: integer
  Count of this fetch

  Example: 40
• links: object Links
  Represents the array of links
• total: integer
  total count

  Example: 40

{
    "description":"Collection of items with links",
    "properties":{
        "total":{
            "type":"integer",
            "description":"total count",
            "example":40
        },
        "count":{
            "type":"integer",
            "description":"Count of this fetch",
            "example":40
        },
        "links":{
            "$ref":"#/components/schemas/Links"
        }
    }
}

Nested Schema : schema

Type: object

Target details

Show Source

• targetName: string
  Name of the target

  Example: sales_db1
• targetType: string
  Type of the target

  Example: oracle_database

{
    "description":"Target details",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"sales_db1"
        },
        "targetType":{
            "description":"Type of the target",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

Nested Schema : items

Type: object

Match All

Show Source

• object CreateRestUserDetails
  Details of REST user

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CreateRestUserDetails"
        }
    ]
}

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 URL

  Example: welcome1
• username(required): string
  REST username to be registered with the FPP server

{
    "description":"Details of REST user",
    "required":[
        "username",
        "password"
    ],
    "properties":{
        "username":{
            "description":"REST username to be registered with the FPP server",
            "type":"string"
        },
        "password":{
            "description":"Password to create the REST credential in EM, which is required to make a call to the FPP REST URL",
            "type":"string",
            "format":"password",
            "example":"welcome1"
        }
    }
}

Nested Schema : Links

Type: object

Represents the array of links

Show Source

• next: object Link
  It represents a Link
• previous: object Link
  It represents a Link
• self: object Link
  It represents a Link

{
    "description":"Represents the array of links",
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

Nested Schema : Link

Type: object

It represents a Link

Show Source

• href: string
  URL for the link

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for the link"
        }
    },
    "description":"It represents a Link"
}

Examples

Select an example Payload

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

403 Response

Forbidden

Body ()

Root Schema : MissingPrivErrorResponse

Type: object

Response sent back as an Error in case required privileges are missing

Show Source

• missingPrivileges: array missingPrivileges
  Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Match All

Response sent back as an Error in case required privileges are missing

Show Source

• object ErrorResponse
  Response sent back in the case of an Error

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Nested Schema : missingPrivileges

Type: array

Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

Show Source

• Array of: object MissingPrivilegeSummary
  It represents a Privilege which is missing on a Resource to view or manage it.

{
    "type":"array",
    "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Nested Schema : MissingPrivilegeSummary

Type: object

It represents a Privilege which is missing on a Resource to view or manage it.

Show Source

• displayName: string
  Display Name of Privilege

  Example: Manage
• name: string
  Name of Privilege

  Example: MANAGE_JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        }
    },
    "description":"It represents a Privilege which is missing on a Resource to view or manage it."
}

404 Response

Not Found

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

503 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Back to Top