Home /  API Reference / 

SFTP

Download OpenAPI

ReadUser

GET/users/{username}
Retrieve a user.
Parameters
Requiredpath
The username used to log in to the SFTP endpoint. Pattern: ^([A-Z0-9]+)$

Example

GET
https://api.sftp.us.stedi.com/2022-04-01/users/7

UpdateUser

PUT/users/{username}
Update a user.
Parameters
Requiredpath
The username used to log in to the SFTP endpoint. Pattern: ^([A-Z0-9]+)$
Request body

application/json

Requiredstring
SFTP user description.

Example

PUT
https://api.sftp.us.stedi.com/2022-04-01/users/Z

DeleteUser

DELETE/users/{username}
Delete a user.
Parameters
Requiredpath
The username used to log in to the SFTP endpoint. Pattern: ^([A-Z0-9]+)$

Example

DELETE
https://api.sftp.us.stedi.com/2022-04-01/users/S

ListUsers

GET/users
Retrieve a list of users.
Parameters
Optionalquery
Limit response to this number of resources. Default to 25.
Optionalquery
The value of token returned in prior request (used for pagination).

Example

GET
https://api.sftp.us.stedi.com/2022-04-01/users?pageSize=35&pageToken=...

CreateUser

POST/users
Create a new user.
Request body

application/json

Requiredstring
SFTP user description.
Optionalobject
PasswordOptions object.

Requiredstring
The user's home directory.

Example

POST
https://api.sftp.us.stedi.com/2022-04-01/users