Jump to

• Request
• Response

Search for users

get

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

Search for all users, those configured for File Server, or by group name

Request

Query Parameters

• configuredUsersOnly(required): boolean
  Search for all users (false) or configured File Server users only

  Default Value: false
• searchCriteria(required): string
  searchCriteria

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: object

Read Only: true

Provides user search result

Show Source

• users: array users

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

Nested Schema : users

Type: array

Show Source

• Array of: object userConfig
  describes user's fileserver metadata

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

Nested Schema : userConfig

Type: object

describes user's fileserver metadata

Show Source

• effectiveHomeDirectory: string
  Read Only: true

  Computed home/landing folder. It can be different from homeDirectory when home type is none as user will derive home from one its group.
• firstName: string
  Read Only: true
• homeDirectory: string
  Home directory or landing folder. Absolute path of the home folder when homeType is not 'None'
• homeType: string
  Allowed Values: [ "Default", "Custom", "None" ]

  The type of home folder the user has. 'Default' is /home/users/{username}. 'Custom' means use the path specified by homeDirectory. 'None' menas there will not be a home folder created for the user and the landing folder willbe determined by thier group membership.
• lastName: string
  Read Only: true
• mailId: string
  Read Only: true
• middleName: string
  Read Only: true
• name: string
  Read Only: true
• publicKeyConfigured: boolean
• status: string
  Allowed Values: [ "not configured", "enabled", "disabled" ]

  User's status. 'disabled' users can have permissions set while still being prevented from accessing the server. 'not configured' users will not have any associated permissions or other metadata.
• userGroups: array userGroups
  Read Only: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        },
        "firstName":{
            "type":"string",
            "readOnly":true
        },
        "middleName":{
            "type":"string",
            "readOnly":true
        },
        "lastName":{
            "type":"string",
            "readOnly":true
        },
        "mailId":{
            "type":"string",
            "readOnly":true
        },
        "status":{
            "type":"string",
            "description":"User's status. 'disabled' users can have permissions set while still being prevented from accessing the server.  'not configured' users will not have any associated permissions or other metadata.",
            "enum":[
                "not configured",
                "enabled",
                "disabled"
            ]
        },
        "homeType":{
            "type":"string",
            "description":"The type of home folder the user has.  'Default' is /home/users/{username}.  'Custom' means use the path specified by homeDirectory.  'None' menas there will not be a home folder created for the user and the landing folder willbe determined by thier group membership.",
            "enum":[
                "Default",
                "Custom",
                "None"
            ]
        },
        "homeDirectory":{
            "type":"string",
            "description":"Home directory or landing folder. Absolute path of the home folder when homeType is not 'None'",
            "nullable":true
        },
        "effectiveHomeDirectory":{
            "type":"string",
            "description":"Computed home/landing folder. It can be different from homeDirectory when home type is none as user will derive home from one its group.",
            "readOnly":true
        },
        "userGroups":{
            "type":"array",
            "readOnly":true,
            "items":{
                "type":"string",
                "readOnly":true
            }
        },
        "publicKeyConfigured":{
            "type":"boolean"
        }
    },
    "description":"describes user's fileserver metadata",
    "xml":{
        "name":"userConfig"
    }
}

Nested Schema : userGroups

Type: array

Read Only: true

Show Source

• Array of: string
  Read Only: true

{
    "type":"array",
    "readOnly":true,
    "items":{
        "type":"string",
        "readOnly":true
    }
}

401 Response

Not authorized to get users

404 Response

Service not found

500 Response

Internal Server Error

Back to Top