Jump to

• Request
• Response

Search Groups

get

{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/groups

Search groups by given criteria

Request

Query Parameters

• configuredGroupsOnly: boolean
  Flag to search for all groups or only configured File Server groups

  Default Value: false
• searchCriteria(required): string
  Search groups having specified name criteria

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : groups

Type: object

Read Only: true

Provides group search result

Show Source

• groups: array groups

{
    "type":"object",
    "properties":{
        "groups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FileServerGroup"
            }
        }
    },
    "description":"Provides group search result",
    "readOnly":true,
    "xml":{
        "name":"groups"
    }
}

Nested Schema : groups

Type: array

Show Source

• Array of: object schema
  describes group's fileserver metadata

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FileServerGroup"
    }
}

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

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"Group's status",
            "enum":[
                "not configured",
                "enabled",
                "disabled"
            ]
        },
        "homeType":{
            "type":"string",
            "description":"Home type",
            "enum":[
                "Default",
                "Custom",
                "None"
            ]
        },
        "homeDirectory":{
            "type":"string",
            "description":"Home directory or landing folder for group",
            "nullable":true
        }
    },
    "description":"describes group's fileserver metadata",
    "xml":{
        "name":"groupConfig"
    }
}

401 Response

Unauthorized to get groups

404 Response

Groups unavailable

500 Response

Internal server error

Back to Top