GET
/
servers
/
{serverId}
/
users
/
{username}
/
config
SFTP User Authentication
curl --request GET \
  --url https://{appDomain}/servers/{serverId}/users/{username}/config \
  --header 'Authorization: Bearer <token>' \
  --header 'Password: <password>'
{
  "Role": "arn:aws:iam::.....:role/UploadBackups",
  "HomeDirectory": "/altostrat-...-bucket/site-uuid-here",
  "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"AllowListingOfUserFolder\",...}]}"
}

Authorizations

​
Authorization
string
header
required

Standard JWT token obtained via a separate authentication process. Required for most user-facing API endpoints.

Headers

​
Password
string
required

The temporary password generated for the SFTP backup script.

Path Parameters

​
serverId
string
required

The AWS SFTP server ID.

Example:

"s-12345abcdef"

​
username
string
required

The SFTP username, which is the Site UUID.

Response

200
application/json

Authentication successful. Returns IAM role and S3 policy.

The response is of type object.