Search groups
get
{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/groups
Search groups by given criteria
Request
Query Parameters
-
configuredGroupsOnly(required): boolean
Flag to search for all groups or only configured File Server groupsDefault Value:
false
-
searchCriteria(required): string
searchCriteria
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success
Nested Schema : groups
Type:
Show Source
array
-
Array of:
object schema
describes group's fileserver metadata
Nested Schema : schema
Type:
object
describes group's fileserver metadata
Show Source
-
homeDirectory: string
Home directory or landing folder for group
-
homeType: string
Allowed Values:
[ "Default", "Custom", "None" ]
Home type -
name: string
-
status: string
Allowed Values:
[ "not configured", "enabled", "disabled" ]
Group's status
401 Response
Unauthorized to get groups
404 Response
Groups unavailable
500 Response
Internal server error