Get all SFTP users for a Project

GET/projects/{projectId}/sftp-users/

API version

v2

Request method

GET

Operation ID

sftp-user-list-sftp-users

---

Request

• projectIdstring

  required

  ID of the Project to request SFTPUsers for.

Responses

Response headers

• X-Pagination-Limitnumber
• X-Pagination-Skipnumber
• X-Pagination-TotalCountnumber

Format

application/json

Description

OK

Schema documentation

• Array[
• *object

  A representation of an SFTPUser.

  • accessLevelstring (one of: full, read, unspecified)

    required

    The level of access for an SFTPUser.

  • activeboolean
  • authUpdatedAtstring (date-time)

    required
  • createdAtstring (date-time)

    required
  • descriptionstring

    required
  • directoriesarray of string
    • Array[
    • *string
    ]
• expiresAtstring (date-time)
• hasPasswordboolean

  required
• idstring

  required
• projectIdstring

  required
• publicKeysarray of object
  • Array[
  • *object

    A representation of an ssh-public-key.

    • commentstring

      required
    • keystring

      required
  ]

updatedAtstring (date-time)

userNamestring

required

]

Example

[
  {
    "accessLevel": "full",
    "active": true,
    "authUpdatedAt": "2024-11-08T18:07:44.551Z",
    "createdAt": "2024-11-08T18:07:44.551Z",
    "description": "string",
    "directories": [
      "string"
    ],
    "expiresAt": "2024-11-08T18:07:44.551Z",
    "hasPassword": true,
    "id": "string",
    "projectId": "string",
    "publicKeys": [
      {
        "comment": "string",
        "key": "string"
      }
    ],
    "updatedAt": "2024-11-08T18:07:44.551Z",
    "userName": "string"
  }
]

JSON Schema

{
  "items": {
    "description": "A representation of an SFTPUser.",
    "properties": {
      "accessLevel": {
        "description": "The level of access for an SFTPUser.",
        "enum": [
          "full",
          "read",
          "unspecified"
        ],
        "type": "string"
      },
      "active": {
        "type": "boolean"
      },
      "authUpdatedAt": {
        "format": "date-time",
        "type": "string"
      },
      "createdAt": {
        "format": "date-time",
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "directories": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "expiresAt": {
        "format": "date-time",
        "type": "string"
      },
      "hasPassword": {
        "type": "boolean"
      },
      "id": {
        "type": "string"
      },
      "projectId": {
        "type": "string"
      },
      "publicKeys": {
        "items": {
          "description": "A representation of an ssh-public-key.",
          "properties": {
            "comment": {
              "type": "string"
            },
            "key": {
              "type": "string"
            }
          },
          "required": [
            "comment",
            "key"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "updatedAt": {
        "format": "date-time",
        "type": "string"
      },
      "userName": {
        "type": "string"
      }
    },
    "required": [
      "id",
      "projectId",
      "description",
      "userName",
      "createdAt",
      "authUpdatedAt",
      "accessLevel",
      "hasPassword"
    ],
    "type": "object"
  },
  "type": "array"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/projects/string/sftp-users?limit=50

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.sshsftpUser.sftpUserListSftpUsers({
  "projectId": "string",
  "queryParameters": {
    "limit": 50
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\SSHSFTPUser\SftpUserListSftpUsers\SftpUserListSftpUsersRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new SftpUserListSftpUsersRequest(
  projectId: "string"
))
  ->withLimit(50);
$response = $client->sshsftpUser()->sftpUserListSftpUsers($request);

var_dump($response->getBody();