> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# sophos-central-directory

> Sophos Directory — users, user groups, administrators, and roles

**Server path:** `/sophos-central-directory` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                    | Description             |
| ------------------------------------------------------------------------------------------------------- | ----------------------- |
| [`sophos-central-directory_add_users_to_group`](#sophos-central-directory_add_users_to_group)           | Add users to group      |
| [`sophos-central-directory_create_user`](#sophos-central-directory_create_user)                         | Create directory user   |
| [`sophos-central-directory_create_user_group`](#sophos-central-directory_create_user_group)             | Create user group       |
| [`sophos-central-directory_delete_user`](#sophos-central-directory_delete_user)                         | Delete user             |
| [`sophos-central-directory_delete_user_group`](#sophos-central-directory_delete_user_group)             | Delete user group       |
| [`sophos-central-directory_get_user`](#sophos-central-directory_get_user)                               | Get user details        |
| [`sophos-central-directory_get_user_group`](#sophos-central-directory_get_user_group)                   | Get user group          |
| [`sophos-central-directory_list_admins`](#sophos-central-directory_list_admins)                         | List administrators     |
| [`sophos-central-directory_list_roles`](#sophos-central-directory_list_roles)                           | List roles              |
| [`sophos-central-directory_list_user_group_members`](#sophos-central-directory_list_user_group_members) | List user group members |
| [`sophos-central-directory_list_user_groups`](#sophos-central-directory_list_user_groups)               | List user groups        |
| [`sophos-central-directory_list_users`](#sophos-central-directory_list_users)                           | List directory users    |
| [`sophos-central-directory_remove_user_from_group`](#sophos-central-directory_remove_user_from_group)   | Remove user from group  |
| [`sophos-central-directory_update_user`](#sophos-central-directory_update_user)                         | Update user             |
| [`sophos-central-directory_update_user_group`](#sophos-central-directory_update_user_group)             | Update user group       |

***

## sophos-central-directory\_add\_users\_to\_group

Add users to group

**Parameters:**

| Parameter | Type      | Required | Default | Description     |
| --------- | --------- | -------- | ------- | --------------- |
| `groupId` | string    | Yes      | —       | Group ID        |
| `ids`     | string\[] | Yes      | —       | User IDs to add |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "groupId": {
        "type": "string",
        "description": "Group ID"
      },
      "ids": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "User IDs to add"
      }
    },
    "required": [
      "PCID",
      "groupId",
      "ids"
    ]
  }
  ```
</Expandable>

***

## sophos-central-directory\_create\_user

Create directory user

**Parameters:**

| Parameter       | Type   | Required | Default | Description    |
| --------------- | ------ | -------- | ------- | -------------- |
| `email`         | string | No       | —       | Email address  |
| `exchangeLogin` | string | No       | —       | Exchange login |
| `firstName`     | string | Yes      | —       | First name     |
| `lastName`      | string | Yes      | —       | Last name      |
| `name`          | string | Yes      | —       | Display name   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "email": {
        "type": "string",
        "description": "Email address"
      },
      "exchangeLogin": {
        "type": "string",
        "description": "Exchange login"
      },
      "firstName": {
        "type": "string",
        "description": "First name"
      },
      "lastName": {
        "type": "string",
        "description": "Last name"
      },
      "name": {
        "type": "string",
        "description": "Display name"
      }
    },
    "required": [
      "PCID",
      "firstName",
      "lastName",
      "name"
    ]
  }
  ```
</Expandable>

***

## sophos-central-directory\_create\_user\_group

Create user group

**Parameters:**

| Parameter     | Type   | Required | Default | Description       |
| ------------- | ------ | -------- | ------- | ----------------- |
| `description` | string | No       | —       | Group description |
| `name`        | string | Yes      | —       | Group name        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "description": {
        "type": "string",
        "description": "Group description"
      },
      "name": {
        "type": "string",
        "description": "Group name"
      }
    },
    "required": [
      "PCID",
      "name"
    ]
  }
  ```
</Expandable>

***

## sophos-central-directory\_delete\_user

Delete user

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId`  | string | Yes      | —       | User ID     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "userId": {
        "type": "string",
        "description": "User ID"
      }
    },
    "required": [
      "PCID",
      "userId"
    ]
  }
  ```
</Expandable>

***

## sophos-central-directory\_delete\_user\_group

Delete user group

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `groupId` | string | Yes      | —       | Group ID    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "groupId": {
        "type": "string",
        "description": "Group ID"
      }
    },
    "required": [
      "PCID",
      "groupId"
    ]
  }
  ```
</Expandable>

***

## sophos-central-directory\_get\_user

Get user details

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId`  | string | Yes      | —       | User ID     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "userId": {
        "type": "string",
        "description": "User ID"
      }
    },
    "required": [
      "PCID",
      "userId"
    ]
  }
  ```
</Expandable>

***

## sophos-central-directory\_get\_user\_group

Get user group

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `groupId` | string | Yes      | —       | Group ID    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "groupId": {
        "type": "string",
        "description": "Group ID"
      }
    },
    "required": [
      "PCID",
      "groupId"
    ]
  }
  ```
</Expandable>

***

## sophos-central-directory\_list\_admins

List administrators

**Parameters:**

| Parameter  | Type    | Required | Default | Description    |
| ---------- | ------- | -------- | ------- | -------------- |
| `pageSize` | integer | No       | —       | Items per page |
| `page`     | integer | No       | —       | Page number    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "pageSize": {
        "type": "integer",
        "description": "Items per page"
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## sophos-central-directory\_list\_roles

List roles

**Parameters:**

| Parameter  | Type    | Required | Default | Description    |
| ---------- | ------- | -------- | ------- | -------------- |
| `pageSize` | integer | No       | —       | Items per page |
| `page`     | integer | No       | —       | Page number    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "pageSize": {
        "type": "integer",
        "description": "Items per page"
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## sophos-central-directory\_list\_user\_group\_members

List user group members

**Parameters:**

| Parameter  | Type    | Required | Default | Description    |
| ---------- | ------- | -------- | ------- | -------------- |
| `groupId`  | string  | Yes      | —       | Group ID       |
| `pageSize` | integer | No       | —       | Items per page |
| `page`     | integer | No       | —       | Page number    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "groupId": {
        "type": "string",
        "description": "Group ID"
      },
      "pageSize": {
        "type": "integer",
        "description": "Items per page"
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      }
    },
    "required": [
      "PCID",
      "groupId"
    ]
  }
  ```
</Expandable>

***

## sophos-central-directory\_list\_user\_groups

List user groups

**Parameters:**

| Parameter  | Type    | Required | Default | Description              |
| ---------- | ------- | -------- | ------- | ------------------------ |
| `pageSize` | integer | No       | —       | Number of items per page |
| `page`     | integer | No       | —       | Page number              |
| `search`   | string  | No       | —       | Search by group name     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "pageSize": {
        "type": "integer",
        "description": "Number of items per page"
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      },
      "search": {
        "type": "string",
        "description": "Search by group name"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## sophos-central-directory\_list\_users

List directory users

**Parameters:**

| Parameter  | Type    | Required | Default | Description              |
| ---------- | ------- | -------- | ------- | ------------------------ |
| `pageSize` | integer | No       | —       | Number of items per page |
| `page`     | integer | No       | —       | Page number              |
| `search`   | string  | No       | —       | Search by name or email  |
| `groupId`  | string  | No       | —       | Filter by group ID       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "pageSize": {
        "type": "integer",
        "description": "Number of items per page"
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      },
      "search": {
        "type": "string",
        "description": "Search by name or email"
      },
      "groupId": {
        "type": "string",
        "description": "Filter by group ID"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## sophos-central-directory\_remove\_user\_from\_group

Remove user from group

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `groupId` | string | Yes      | —       | Group ID    |
| `userId`  | string | Yes      | —       | User ID     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "groupId": {
        "type": "string",
        "description": "Group ID"
      },
      "userId": {
        "type": "string",
        "description": "User ID"
      }
    },
    "required": [
      "PCID",
      "groupId",
      "userId"
    ]
  }
  ```
</Expandable>

***

## sophos-central-directory\_update\_user

Update user

**Parameters:**

| Parameter   | Type   | Required | Default | Description          |
| ----------- | ------ | -------- | ------- | -------------------- |
| `userId`    | string | Yes      | —       | User ID              |
| `email`     | string | No       | —       | Updated email        |
| `firstName` | string | No       | —       | Updated first name   |
| `lastName`  | string | No       | —       | Updated last name    |
| `name`      | string | No       | —       | Updated display name |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "userId": {
        "type": "string",
        "description": "User ID"
      },
      "email": {
        "type": "string",
        "description": "Updated email"
      },
      "firstName": {
        "type": "string",
        "description": "Updated first name"
      },
      "lastName": {
        "type": "string",
        "description": "Updated last name"
      },
      "name": {
        "type": "string",
        "description": "Updated display name"
      }
    },
    "required": [
      "PCID",
      "userId"
    ]
  }
  ```
</Expandable>

***

## sophos-central-directory\_update\_user\_group

Update user group

**Parameters:**

| Parameter     | Type   | Required | Default | Description         |
| ------------- | ------ | -------- | ------- | ------------------- |
| `groupId`     | string | Yes      | —       | Group ID            |
| `description` | string | No       | —       | Updated description |
| `name`        | string | No       | —       | Updated group name  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "groupId": {
        "type": "string",
        "description": "Group ID"
      },
      "description": {
        "type": "string",
        "description": "Updated description"
      },
      "name": {
        "type": "string",
        "description": "Updated group name"
      }
    },
    "required": [
      "PCID",
      "groupId"
    ]
  }
  ```
</Expandable>