> ## 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.

# netdocuments-admin

> NetDocuments Administration - manage cabinets, workspaces, users, groups, and repositories

**Server path:** `/netdocuments-admin` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                    | Description                                                  |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| [`netdocuments_admin_add_or_remove_group_member`](#netdocuments_admin_add_or_remove_group_member)       | Add or remove group member                                   |
| [`netdocuments_admin_create_collab_space`](#netdocuments_admin_create_collab_space)                     | Create CollabSpace                                           |
| [`netdocuments_admin_create_repository_group`](#netdocuments_admin_create_repository_group)             | Create repository group                                      |
| [`netdocuments_admin_create_workspace_parent_child`](#netdocuments_admin_create_workspace_parent_child) | Get or create a workspace (with parent and child attributes) |
| [`netdocuments_admin_create_workspace_single`](#netdocuments_admin_create_workspace_single)             | Get or create a workspace (with a single attribute)          |
| [`netdocuments_admin_delete_repository_group`](#netdocuments_admin_delete_repository_group)             | Delete repository group                                      |
| [`netdocuments_admin_get_cabinet_custom_attributes`](#netdocuments_admin_get_cabinet_custom_attributes) | Get cabinet custom attributes                                |
| [`netdocuments_admin_get_cabinet_groups`](#netdocuments_admin_get_cabinet_groups)                       | Get cabinet groups                                           |
| [`netdocuments_admin_get_cabinet_information`](#netdocuments_admin_get_cabinet_information)             | Get cabinet information                                      |
| [`netdocuments_admin_get_cabinet_settings`](#netdocuments_admin_get_cabinet_settings)                   | Get cabinet settings                                         |
| [`netdocuments_admin_get_current_user_info`](#netdocuments_admin_get_current_user_info)                 | Get current user info                                        |
| [`netdocuments_admin_get_group_information`](#netdocuments_admin_get_group_information)                 | Get group information                                        |
| [`netdocuments_admin_get_group_membership`](#netdocuments_admin_get_group_membership)                   | Get group membership                                         |
| [`netdocuments_admin_get_repository_groups`](#netdocuments_admin_get_repository_groups)                 | Get repository groups                                        |
| [`netdocuments_admin_get_repository_information`](#netdocuments_admin_get_repository_information)       | Get repository information                                   |
| [`netdocuments_admin_get_repository_log`](#netdocuments_admin_get_repository_log)                       | Get repository log                                           |
| [`netdocuments_admin_get_repository_users`](#netdocuments_admin_get_repository_users)                   | Get repository users                                         |
| [`netdocuments_admin_get_user_cabinets`](#netdocuments_admin_get_user_cabinets)                         | Get list of user cabinets                                    |
| [`netdocuments_admin_get_user_info`](#netdocuments_admin_get_user_info)                                 | Get user info                                                |
| [`netdocuments_admin_get_workspace_information`](#netdocuments_admin_get_workspace_information)         | Get workspace information                                    |
| [`netdocuments_admin_refresh_workspace`](#netdocuments_admin_refresh_workspace)                         | Refresh a workspace                                          |

***

## netdocuments\_admin\_add\_or\_remove\_group\_member

Add or remove group member

**Parameters:**

| Parameter | Type   | Required | Default | Description                                   |
| --------- | ------ | -------- | ------- | --------------------------------------------- |
| `groupID` | string | Yes      | —       | (Starts with UG-)                             |
| `action`  | string | Yes      | —       | Add or remove the user                        |
| `member`  | string | Yes      | —       | (Must be a member of the repository already.) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "groupID": {
        "type": "string",
        "description": "(Starts with UG-)"
      },
      "action": {
        "type": "string",
        "description": "Add or remove the user",
        "enum": [
          "add",
          "remove"
        ]
      },
      "member": {
        "type": "string",
        "description": "(Must be a member of the repository already.)"
      }
    },
    "required": [
      "PCID",
      "groupID",
      "action",
      "member"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_create\_collab\_space

Create CollabSpace

**Parameters:**

| Parameter      | Type    | Required | Default | Description           |
| -------------- | ------- | -------- | ------- | --------------------- |
| `workspaceID`  | string  | Yes      | —       | Workspace ID          |
| `name`         | string  | Yes      | —       | CollabSpace name      |
| `sanitizeName` | boolean | Yes      | —       | Sanitize Name         |
| `description`  | string  | No       | —       | The description value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "workspaceID": {
        "type": "string",
        "description": "Workspace ID"
      },
      "name": {
        "type": "string",
        "description": "CollabSpace name"
      },
      "sanitizeName": {
        "type": "boolean",
        "description": "Sanitize Name"
      },
      "description": {
        "type": "string",
        "description": "The description value"
      }
    },
    "required": [
      "PCID",
      "workspaceID",
      "name",
      "sanitizeName"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_create\_repository\_group

Create repository group

**Parameters:**

| Parameter        | Type    | Required | Default | Description          |
| ---------------- | ------- | -------- | ------- | -------------------- |
| `repositoryID`   | string  | Yes      | —       | (It starts with CA-) |
| `name`           | string  | Yes      | —       | Group name           |
| `external`       | boolean | Yes      | —       | The external value   |
| `hidden`         | boolean | Yes      | —       | Hide in lists        |
| `hideMembership` | boolean | Yes      | —       | Hidden membership    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "repositoryID": {
        "type": "string",
        "description": "(It starts with CA-)"
      },
      "name": {
        "type": "string",
        "description": "Group name"
      },
      "external": {
        "type": "boolean",
        "description": "The external value"
      },
      "hidden": {
        "type": "boolean",
        "description": "Hide in lists"
      },
      "hideMembership": {
        "type": "boolean",
        "description": "Hidden membership"
      }
    },
    "required": [
      "PCID",
      "repositoryID",
      "name",
      "external",
      "hidden",
      "hideMembership"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_create\_workspace\_parent\_child

Get or create a workspace (with parent and child attributes)

**Parameters:**

| Parameter   | Type   | Required | Default | Description                                                |
| ----------- | ------ | -------- | ------- | ---------------------------------------------------------- |
| `cabinetID` | string | Yes      | —       | (It starts with NG-)                                       |
| `parentID`  | string | Yes      | —       | The parent value used to define workspaces in the cabinet. |
| `childID`   | string | Yes      | —       | The child value used to define workspaces in the cabinet.  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "cabinetID": {
        "type": "string",
        "description": "(It starts with NG-)"
      },
      "parentID": {
        "type": "string",
        "description": "The parent value used to define workspaces in the cabinet."
      },
      "childID": {
        "type": "string",
        "description": "The child value used to define workspaces in the cabinet."
      }
    },
    "required": [
      "PCID",
      "cabinetID",
      "parentID",
      "childID"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_create\_workspace\_single

Get or create a workspace (with a single attribute)

**Parameters:**

| Parameter   | Type   | Required | Default | Description                                              |
| ----------- | ------ | -------- | ------- | -------------------------------------------------------- |
| `cabinetID` | string | Yes      | —       | (It starts with NG-)                                     |
| `parentID`  | string | Yes      | —       | The sole value used to define workspaces in the cabinet. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "cabinetID": {
        "type": "string",
        "description": "(It starts with NG-)"
      },
      "parentID": {
        "type": "string",
        "description": "The sole value used to define workspaces in the cabinet."
      }
    },
    "required": [
      "PCID",
      "cabinetID",
      "parentID"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_delete\_repository\_group

Delete repository group

**Parameters:**

| Parameter      | Type   | Required | Default | Description          |
| -------------- | ------ | -------- | ------- | -------------------- |
| `repositoryID` | string | Yes      | —       | (It starts with CA-) |
| `groupID`      | string | Yes      | —       | (Starts with UG-)    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "repositoryID": {
        "type": "string",
        "description": "(It starts with CA-)"
      },
      "groupID": {
        "type": "string",
        "description": "(Starts with UG-)"
      }
    },
    "required": [
      "PCID",
      "repositoryID",
      "groupID"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_get\_cabinet\_custom\_attributes

Get cabinet custom attributes

**Parameters:**

| Parameter   | Type   | Required | Default | Description          |
| ----------- | ------ | -------- | ------- | -------------------- |
| `cabinetID` | string | Yes      | —       | (It starts with NG-) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "cabinetID": {
        "type": "string",
        "description": "(It starts with NG-)"
      }
    },
    "required": [
      "PCID",
      "cabinetID"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_get\_cabinet\_groups

Get cabinet groups

**Parameters:**

| Parameter   | Type   | Required | Default | Description          |
| ----------- | ------ | -------- | ------- | -------------------- |
| `cabinetID` | string | Yes      | —       | (It starts with NG-) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "cabinetID": {
        "type": "string",
        "description": "(It starts with NG-)"
      }
    },
    "required": [
      "PCID",
      "cabinetID"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_get\_cabinet\_information

Get cabinet information

**Parameters:**

| Parameter   | Type   | Required | Default | Description          |
| ----------- | ------ | -------- | ------- | -------------------- |
| `cabinetID` | string | Yes      | —       | (It starts with NG-) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "cabinetID": {
        "type": "string",
        "description": "(It starts with NG-)"
      }
    },
    "required": [
      "PCID",
      "cabinetID"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_get\_cabinet\_settings

Get cabinet settings

**Parameters:**

| Parameter   | Type   | Required | Default | Description          |
| ----------- | ------ | -------- | ------- | -------------------- |
| `cabinetID` | string | Yes      | —       | (It starts with NG-) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "cabinetID": {
        "type": "string",
        "description": "(It starts with NG-)"
      }
    },
    "required": [
      "PCID",
      "cabinetID"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_get\_current\_user\_info

Get current user info

**Parameters:**

| Parameter | Type   | Required | Default | Description          |
| --------- | ------ | -------- | ------- | -------------------- |
| `cabGuid` | string | No       | —       | (It starts with NG-) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "cabGuid": {
        "type": "string",
        "description": "(It starts with NG-)"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_get\_group\_information

Get group information

**Parameters:**

| Parameter       | Type    | Required | Default | Description                                                                                                                          |
| --------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `groupID`       | string  | Yes      | —       | Group ID (starts with UG-).                                                                                                          |
| `cabMembership` | boolean | No       | —       | (If set to 'true' the cabinets this groups is a member of and the default document access rights for each cabinet will be included.) |

<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 (starts with UG-)."
      },
      "cabMembership": {
        "type": "boolean",
        "description": "(If set to 'true' the cabinets this groups is a member of and the default document access rights for each cabinet will be included.)"
      }
    },
    "required": [
      "PCID",
      "groupID"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_get\_group\_membership

Get group membership

**Parameters:**

| Parameter | Type   | Required | Default | Description       |
| --------- | ------ | -------- | ------- | ----------------- |
| `groupID` | string | Yes      | —       | (Starts with UG-) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "groupID": {
        "type": "string",
        "description": "(Starts with UG-)"
      }
    },
    "required": [
      "PCID",
      "groupID"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_get\_repository\_groups

Get repository groups

**Parameters:**

| Parameter      | Type    | Required | Default | Description                                                      |
| -------------- | ------- | -------- | ------- | ---------------------------------------------------------------- |
| `repositoryID` | string  | Yes      | —       | (It starts with CA-)                                             |
| `$filter`      | string  | No       | —       | (See the documentation for filter criteria)                      |
| `$top`         | string  | No       | —       | (Defaults to 5,000.  Maximum 10,000)                             |
| `paging`       | boolean | No       | —       | (Return the results in pages; default is false)                  |
| `$skiptoken`   | string  | No       | —       | (For paging purposes; returned by prior calls as 'next')         |
| `returnInfo`   | string  | No       | —       | all will return group names. Default is blank to return just IDs |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "repositoryID": {
        "type": "string",
        "description": "(It starts with CA-)"
      },
      "$filter": {
        "type": "string",
        "description": "(See the documentation for filter criteria)"
      },
      "$top": {
        "type": "string",
        "description": "(Defaults to 5,000.  Maximum 10,000)"
      },
      "paging": {
        "type": "boolean",
        "description": "(Return the results in pages; default is false)"
      },
      "$skiptoken": {
        "type": "string",
        "description": "(For paging purposes; returned by prior calls as 'next')"
      },
      "returnInfo": {
        "type": "string",
        "description": "all will return group names. Default is blank to return just IDs",
        "enum": [
          "all",
          ""
        ]
      }
    },
    "required": [
      "PCID",
      "repositoryID"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_get\_repository\_information

Get repository information

**Parameters:**

| Parameter      | Type   | Required | Default | Description       |
| -------------- | ------ | -------- | ------- | ----------------- |
| `repositoryID` | string | Yes      | —       | (Starts with CA-) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "repositoryID": {
        "type": "string",
        "description": "(Starts with CA-)"
      }
    },
    "required": [
      "PCID",
      "repositoryID"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_get\_repository\_log

Get repository log

**Parameters:**

| Parameter      | Type   | Required | Default | Description                                                      |
| -------------- | ------ | -------- | ------- | ---------------------------------------------------------------- |
| `repositoryID` | string | Yes      | —       | (Starts with CA-)                                                |
| `format`       | string | Yes      | —       | The format value                                                 |
| `start`        | string | No       | —       | (Defaults to 30 days; format yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ) |
| `end`          | string | No       | —       | (Same format as start; defaults to today)                        |
| `Logtype`      | string | Yes      | —       | Log type                                                         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "repositoryID": {
        "type": "string",
        "description": "(Starts with CA-)"
      },
      "format": {
        "type": "string",
        "description": "The format value"
      },
      "start": {
        "type": "string",
        "description": "(Defaults to 30 days; format yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ)"
      },
      "end": {
        "type": "string",
        "description": "(Same format as start; defaults to today)"
      },
      "Logtype": {
        "type": "string",
        "description": "Log type",
        "enum": [
          "consolidated",
          "admin"
        ]
      }
    },
    "required": [
      "PCID",
      "repositoryID",
      "format",
      "Logtype"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_get\_repository\_users

Get repository users

**Parameters:**

| Parameter      | Type   | Required | Default | Description       |
| -------------- | ------ | -------- | ------- | ----------------- |
| `repositoryID` | string | Yes      | —       | (Starts with CA-) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "repositoryID": {
        "type": "string",
        "description": "(Starts with CA-)"
      }
    },
    "required": [
      "PCID",
      "repositoryID"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_get\_user\_cabinets

Get list of user cabinets

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

***

## netdocuments\_admin\_get\_user\_info

Get user info

**Parameters:**

| Parameter | Type   | Required | Default | Description                           |
| --------- | ------ | -------- | ------- | ------------------------------------- |
| `id`      | string | Yes      | —       | The user ID assigned by NetDocuments. |
| `cabGuid` | string | No       | —       | (It starts with NG-)                  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The user ID assigned by NetDocuments."
      },
      "cabGuid": {
        "type": "string",
        "description": "(It starts with NG-)"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_admin\_get\_workspace\_information

Get workspace information

**Parameters:**

| Parameter     | Type   | Required | Default | Description  |
| ------------- | ------ | -------- | ------- | ------------ |
| `workspaceID` | string | Yes      | —       | Workspace ID |

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

***

## netdocuments\_admin\_refresh\_workspace

Refresh a workspace

**Parameters:**

| Parameter     | Type   | Required | Default | Description      |
| ------------- | ------ | -------- | ------- | ---------------- |
| `workspaceID` | string | Yes      | —       | Workspace ID     |
| `action`      | string | Yes      | —       | The action value |

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