Create an SFTP user for a Project

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

API version

v2

Request method

POST

Operation ID

sftp-user-create-sftp-user

---

Request

• projectIdstring

  required

  ID of the Project to create an SFTPUser for.

Responses

Format

application/json

Description

Created

Schema documentation

• 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-23T00:28:39.493Z",
  "createdAt": "2024-11-23T00:28:39.493Z",
  "description": "string",
  "directories": [
    "string"
  ],
  "expiresAt": "2024-11-23T00:28:39.493Z",
  "hasPassword": true,
  "id": "string",
  "projectId": "string",
  "publicKeys": [
    {
      "comment": "string",
      "key": "string"
    }
  ],
  "updatedAt": "2024-11-23T00:28:39.493Z",
  "userName": "string"
}

JSON Schema

{
  "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"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"accessLevel":"read","authentication":{"password":"string"},"description":"string","directories":["string"],"expiresAt":"2024-11-23T00:28:39.502Z"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/projects/string/sftp-users

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.sftpUserCreateSftpUser({
  "projectId": "string",
  "data": {
    "accessLevel": "read",
    "authentication": {
      "password": "string"
    },
    "description": "string",
    "directories": [
      "string"
    ],
    "expiresAt": "2024-11-23T00:28:39.502Z"
  }
});

assertStatus(response, 201);
  

PHP SDK

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

// TODO: Please consult the properties and constructor signature of
// SftpUserCreateSftpUserRequestBody to learn how to construct a valid instance
$body = new SftpUserCreateSftpUserRequestBody(/* TODO: ... */);

$request = (new SftpUserCreateSftpUserRequest(
  projectId: "string",
  body: $body
));
$response = $client->sshsftpUser()->sftpUserCreateSftpUser($request);

var_dump($response->getBody();