Get groups | SFTPGo Octri Preview

3 parameters

offsetintegeroptional

Number of items to skip from the beginning of the result set. Used for pagination in combination with the limit parameter

Default:0

limitintegeroptional

The maximum number of items to return. Max value is 500, default is 100

Default:100

orderstringoptional

Ordering groups by name. Default ASC

Allowed:ASCDESC

6 status codes

200successful operation

adminsarray<string>optional

list of admins usernames associated with this group

created_atintegeroptional

Creation time as Unix timestamp in milliseconds.

descriptionstringoptional

Optional free-form description.

idintegeroptional

namestringrequired

Unique group name. Referenced from `User.groups[].name` with a type (primary/secondary/membership).

rolestringoptional

Role name. A group carrying a role with `resource_isolation` enabled is visible to the admins carrying the same role, it is reachable from the accounts of that role and its storage is measured against the allowlist of the role. An admin carrying a role receives that role on the groups it creates. On update the body replaces the stored role: omitting it clears the role, and the change is refused while accounts or admins of another role reference the group

updated_atintegeroptional

Last update time as Unix timestamp in milliseconds.

user_settingsobjectoptional

usersarray<string>optional

list of usernames associated with this group

virtual_foldersarray<object>optional

mapping between virtual SFTPGo paths and folders

400Bad Request

errorstringoptional

error description if any

messagestringoptional

message, can be empty

401Unauthorized

errorstringoptional

error description if any

messagestringoptional

message, can be empty

403Forbidden

errorstringoptional

error description if any

messagestringoptional

message, can be empty

500Internal Server Error

errorstringoptional

error description if any

messagestringoptional

message, can be empty

defaultUnexpected Error

errorstringoptional

error description if any

messagestringoptional

message, can be empty

Error handling

A 400 is returned: Bad Request. A 401 is returned: Unauthorized. A 403 is returned: Forbidden. A 500 is returned: Internal Server Error. Any other status is an error: Unexpected Error.

import { SFTPGoEnterpriseAPIUnofficialOctriFullPreview } from "sftpgo-octri-preview-sdk";

const client = new SFTPGoEnterpriseAPIUnofficialOctriFullPreview({
  baseUrl: "/api/v2",
  auth: { apiKeyAuth: process.env.API_TOKEN! },
});

const result = await client.groups.get();

[
  {
    "admins": [
      "example_value"
    ],
    "created_at": 1,
    "description": "Example description",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example Name",
    "role": "administrator",
    "updated_at": "2026-01-15T09:00:00Z",
    "user_settings": {
      "download_bandwidth": 1,
      "download_data_transfer": 1,
      "expires_in": 1,
      "filesystem": {
        "azblobconfig": {
          "access_tier": "",
          "account_key": {
            "additional_data": "example_value",
            "key": "example_key_abc123",
            "mode": 1,
            "payload": "example_value",
            "status": "Plain"
          },
          "account_name": "Example Name",
          "container": "example_value",
          "download_concurrency": 1,
          "download_part_size": 1,
          "endpoint": "example_value",
          "key_prefix": "folder/subfolder/",
          "managed_identity_client_id": "12345678-1234-1234-1234-123456789012",
          "sas_url": {
            "additional_data": "example_value",
            "key": "example_key_abc123",
            "mode": 1,
            "payload": "example_value",
            "status": "Plain"
          },
          "upload_concurrency": 1,
          "upload_part_size": 1,
          "use_emulator": true
        },
        "cryptconfig": {
          "passphrase": {
            "additional_data": null,
            "key": null,
            "mode": null,
            "payload": null,
            "status": null
          },
          "read_buffer_size": 1,
          "write_buffer_size": 1
        },
        "ftpconfig": {
          "endpoint": "example_value",
          "password": {
            "additional_data": "example_value",
            "key": "example_key_abc123",
            "mode": 1,
            "payload": "example_value",
            "status": "Plain"
          },
          "remote_directory": "example_value",
          "skip_tls_verify": true,
          "tls_mode": "0",
          "username": "janedoe"
        },
        "gcsconfig": {
          "acl": "example_value",
          "automatic_credentials": "0",
          "bucket": "example_value",
          "credentials": {
            "additional_data": "example_value",
            "key": "example_key_abc123",
            "mode": 1,
            "payload": "example_value",
            "status": "Plain"
          },
          "hns": "0",
          "key_prefix": "folder/subfolder/",
          "storage_class": "example_value",
          "universe_domain": "example_value",
          "upload_part_max_time": "2026-01-15T09:00:00Z",
          "upload_part_size": 1
        },
        "httpconfig": {
          "api_key": {
            "additional_data": "example_value",
            "key": "example_key_abc123",
            "mode": 1,
            "payload": "example_value",
            "status": "Plain"
          },
          "endpoint": "example_value",
          "equality_check_mode": "0",
          "password": {
            "additional_data": "example_value",
            "key": "example_key_abc123",
            "mode": 1,
            "payload": "example_value",
            "status": "Plain"
          },
          "remote_directory": "example_value",
          "skip_tls_verify": true,
          "username": "janedoe"
        },
        "osconfig": {
          "read_buffer_size": 1,
          "write_buffer_size": 1
        },
        "provider": "-1",
        "s3config": {
          "access_key": "example_key_abc123",
          "access_secret": {
            "additional_data": "example_value",
            "key": "example_key_abc123",
            "mode": 1,
            "payload": "example_value",
            "status": "Plain"
          },
          "acl": "example_value",
          "bucket": "example_value",
          "checksum_algorithm": "",
          "download_concurrency": 1,
          "download_part_max_time": "2026-01-15T09:00:00Z",
          "download_part_size": 1,
          "endpoint": "example_value",
          "force_path_style": true,
          "key_prefix": "folder/subfolder/",
          "region": "example_value",
          "role_arn": "example_value",
          "session_token": "example_key_abc123",
          "sse_customer_key": {
            "additional_data": null,
            "key": null,
            "mode": null,
            "payload": null,
            "status": null
          },
          "storage_class": "example_value",
          "upload_concurrency": 1,
          "upload_part_max_time": "2026-01-15T09:00:00Z",
          "upload_part_size": 1
        },
        "sftpconfig": {
          "buffer_size": 2,
          "disable_concurrent_reads": true,
          "disable_concurrent_writes": true,
          "endpoint": "example_value",
          "equality_check_mode": "0",
          "fingerprints": [
            "example_value"
          ],
          "key_passphrase": {
            "additional_data": "example_value",
            "key": "example_key_abc123",
            "mode": 1,
            "payload": "example_value",
            "status": "Plain"
          },
          "password": {
            "additional_data": "example_value",
            "key": "example_key_abc123",
            "mode": 1,
            "payload": "example_value",
            "status": "Plain"
          },
          "prefix": "example_value",
          "private_key": {
            "additional_data": "example_value",
            "key": "example_key_abc123",
            "mode": 1,
            "payload": "example_value",
            "status": "Plain"
          },
          "socks_password": {
            "additional_data": "example_value",
            "key": "example_key_abc123",
            "mode": 1,
            "payload": "example_value",
            "status": "Plain"
          },
          "socks_proxy": "example_value",
          "socks_username": "Example Name",
          "username": "janedoe"
        }
      },
      "filters": {
        "access_time": [
          {
            "day_of_week": null,
            "from": null,
            "to": null
          }
        ],
        "allow_api_key_auth": true,
        "allowed_ip": [
          "192.0.2.0/24",
          "2001:db8::/32"
        ],
        "allowed_share_paths": [
          "example_value"
        ],
        "bandwidth_limits": [
          {
            "download_bandwidth": null,
            "sources": null,
            "upload_bandwidth": null
          }
        ],
        "default_shares_expiration": 1,
        "denied_ip": [
          "172.16.0.0/16"
        ],
        "denied_login_methods": [
          "publickey"
        ],
        "denied_protocols": [
          "SSH"
        ],
        "denied_share_paths": [
          "example_value"
        ],
        "denied_share_scopes": [
          "read"
        ],
        "disable_fs_checks": false,
        "enforce_secure_algorithms": true,
        "external_auth_cache_time": "2026-01-15T09:00:00Z",
        "file_patterns": [
          {
            "allowed_patterns": null,
            "denied_patterns": null,
            "deny_policy": null,
            "path": null
          }
        ],
        "ftp_security": "0",
        "hooks": {
          "check_password_disabled": false,
          "external_auth_disabled": false,
          "pre_login_disabled": false
        },
        "is_anonymous": true,
        "max_shares_expiration": 1,
        "max_upload_file_size": 1,
        "password_expiration": 1,
        "password_policy": {
          "digits": 1,
          "length": 1,
          "lowers": 1,
          "specials": 1,
          "uppers": 1
        },
        "password_strength": 1,
        "pre_login_cache_time": "2026-01-15T09:00:00Z",
        "start_directory": "example_value",
        "tls_username": "Example Name",
        "two_factor_protocols": [
          "SSH"
        ],
        "user_type": "",
        "web_client": [
          "publickey-change-disabled"
        ],
        "share_policy": {
          "mode": "0",
          "permissions": 1
        }
      },
      "home_dir": "example_value",
      "max_sessions": 1,
      "permissions": {
        "/": [
          "*"
        ],
        "/somedir": [
          "list",
          "download"
        ]
      },
      "quota_files": 1,
      "quota_size": 1,
      "total_data_transfer": 42,
      "upload_bandwidth": 1,
      "upload_data_transfer": 1
    },
    "users": [
      "example_value"
    ],
    "virtual_folders": [
      {
        "description": "Example description",
        "filesystem": {
          "azblobconfig": {
            "access_tier": null,
            "account_key": null,
            "account_name": null,
            "container": null,
            "download_concurrency": null,
            "download_part_size": null,
            "endpoint": null,
            "key_prefix": null,
            "managed_identity_client_id": null,
            "sas_url": null,
            "upload_concurrency": null,
            "upload_part_size": null,
            "use_emulator": null
          },
          "cryptconfig": {
            "passphrase": null,
            "read_buffer_size": null,
            "write_buffer_size": null
          },
          "ftpconfig": {
            "endpoint": null,
            "password": null,
            "remote_directory": null,
            "skip_tls_verify": null,
            "tls_mode": null,
            "username": null
          },
          "gcsconfig": {
            "acl": null,
            "automatic_credentials": null,
            "bucket": null,
            "credentials": null,
            "hns": null,
            "key_prefix": null,
            "storage_class": null,
            "universe_domain": null,
            "upload_part_max_time": null,
            "upload_part_size": null
          },
          "httpconfig": {
            "api_key": null,
            "endpoint": null,
            "equality_check_mode": null,
            "password": null,
            "remote_directory": null,
            "skip_tls_verify": null,
            "username": null
          },
          "osconfig": {
            "read_buffer_size": null,
            "write_buffer_size": null
          },
          "provider": "-1",
          "s3config": {
            "access_key": null,
            "access_secret": null,
            "acl": null,
            "bucket": null,
            "checksum_algorithm": null,
            "download_concurrency": null,
            "download_part_max_time": null,
            "download_part_size": null,
            "endpoint": null,
            "force_path_style": null,
            "key_prefix": null,
            "region": null,
            "role_arn": null,
            "session_token": null,
            "sse_customer_key": null,
            "storage_class": null,
            "upload_concurrency": null,
            "upload_part_max_time": null,
            "upload_part_size": null
          },
          "sftpconfig": {
            "buffer_size": null,
            "disable_concurrent_reads": null,
            "disable_concurrent_writes": null,
            "endpoint": null,
            "equality_check_mode": null,
            "fingerprints": null,
            "key_passphrase": null,
            "password": null,
            "prefix": null,
            "private_key": null,
            "socks_password": null,
            "socks_proxy": null,
            "socks_username": null,
            "username": null
          }
        },
        "groups": [
          "example_value"
        ],
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "last_quota_update": "2026-01-15T09:00:00Z",
        "mapped_path": "example_value",
        "name": "Example Name",
        "role": "administrator",
        "used_quota_files": 1,
        "used_quota_size": 1,
        "users": [
          "example_value"
        ],
        "exposed_subpaths": [
          "example_value"
        ],
        "quota_files": 1,
        "quota_size": 1,
        "subpath": "example_value",
        "virtual_path": "example_value"
      }
    ]
  }
]

Request

Response

Errors