groups

Get groups

Returns an array with one or more groups

get/groups

Request

Base URL
/api/v2 (relative, and the document was published on a file host, not at the API’s origin)
Auth
- HTTP bearer
- or API key in header X-SFTPGO-API-KEY
TypeScript
https://skmtc.dev/kanton-bern/apis/sftpgo/docs/groups/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

offsetinteger

limitinteger

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

order'ASC' | 'DESC'

Example:ASC

Ordering groups by name. Default ASC

Response

successful operation

idinteger

namestring

name is unique

descriptionstring

optional description

created_atinteger

creation time as unix timestamp in milliseconds

updated_atinteger

last update time as unix timestamp in milliseconds

usersstring[]

list of usernames associated with this group

adminsstring[]

list of admins usernames associated with this group

Example response

[
  {
    "user_settings": {
      "permissions": {
        "/": [
          "*"
        ],
        "/somedir": [
          "list",
          "download"
        ]
      },
      "filters": {
        "allowed_ip": [
          "192.0.2.0/24",
          "2001:db8::/32"
        ],
        "denied_ip": [
          "172.16.0.0/16"
        ],
        "file_patterns": [
          {
            "allowed_patterns": [
              "*.jpg",
              "a*b?.png"
            ],
            "denied_patterns": [
              "*.zip"
            ]
          }
        ]
      },
      "filesystem": {
        "s3config": {
          "key_prefix": "folder/subfolder/"
        },
        "gcsconfig": {
          "key_prefix": "folder/subfolder/"
        },
        "azblobconfig": {
          "key_prefix": "folder/subfolder/"
        },
        "sftpconfig": {
          "buffer_size": 2
        }
      }
    },
    "virtual_folders": [
      {
        "filesystem": {
          "s3config": {
            "key_prefix": "folder/subfolder/"
          },
          "gcsconfig": {
            "key_prefix": "folder/subfolder/"
          },
          "azblobconfig": {
            "key_prefix": "folder/subfolder/"
          },
          "sftpconfig": {
            "buffer_size": 2
          }
        }
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.