Jump to

• Request
• Response

Update a group

put

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

Update a group

Request

Path Parameters

• group(required): string
  group

Supported Media Types

• application/json

Request Body - application/json ()

Updated group object

Root 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"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root 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 update group details

404 Response

Group Unavailable

500 Response

Internal Server Error

Back to Top