Post x amz targettransferservice.createuser

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1458293303.1 KB

Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the <code>IdentityProviderType</code> set to <code>SERVICE_MANAGED</code>. Using parameters for <code>CreateUser</code>, you can specify the user name, set the home directory, store the user's public key, and assign the user's Identity and Access Management (IAM) role. You can also optionally add a session policy, and assign metadata with tags that can be used to group and search for users.

post/#X-Amz-Target=TransferService.CreateUser

Headers

X-Amz-Target'TransferService.CreateUser' required

Request body

HomeDirectorystring

The landing directory (folder) for a user when they log in to the server using the client. A <code>HomeDirectory</code> example is <code>/bucket_name/home/mydirectory</code>.

HomeDirectoryType'PATH' | 'LOGICAL'

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to <code>PATH</code>, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it <code>LOGICAL</code>, you need to provide mappings in the <code>HomeDirectoryMappings</code> for how you want to make Amazon S3 or Amazon EFS paths visible to your users.

Policystring

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>. <note> This policy applies only when the domain of <code>ServerId</code> is Amazon S3. Amazon EFS does not use session policies. For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the <code>Policy</code> argument. For an example of a session policy, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html">Example session policy</a>. For more information, see <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> in the Amazon Web Services Security Token Service API Reference. </note>

Rolestring required

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

ServerIdstring required

A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

SshPublicKeyBodystring

The public portion of the Secure Shell (SSH) key used to authenticate the user to the server. The three standard SSH public key format elements are <code><key type></code>, <code><body base64></code>, and an optional <code><comment></code>, with spaces between each element. Transfer Family accepts RSA, ECDSA, and ED25519 keys. <ul> <li> For RSA keys, the key type is <code>ssh-rsa</code>. </li> <li> For ED25519 keys, the key type is <code>ssh-ed25519</code>. </li> <li> For ECDSA keys, the key type is either <code>ecdsa-sha2-nistp256</code>, <code>ecdsa-sha2-nistp384</code>, or <code>ecdsa-sha2-nistp521</code>, depending on the size of the key you generated. </li> </ul>

UserNamestring required

A unique string that identifies a user and is associated with a <code>ServerId</code>. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.

Response

Success

ServerIdstring required

The identifier of the server that the user is attached to.

UserNamestring required

A unique string that identifies a user account associated with a server.