BatchCreateUserRequestItem
Contains the details for a single user to be created in a batch user creation request.
Note
A user can only be assigned to a single security group. Attempting to add a user to multiple security groups is not supported and will result in an error.
Note
codeValidation, inviteCode, and inviteCodeTtl
are restricted to networks under preview only.
Contents
Note
In the following list, the required parameters are described first.
- securityGroupIds
-
A list of security group IDs to which the user should be assigned.
Type: Array of strings
Pattern:
[\S]+Required: Yes
- username
-
The email address or username for the user. Must be unique within the network.
Type: String
Pattern:
[\S\s]*Required: Yes
- codeValidation
-
Indicates whether the user can be verified through a custom invite code.
Type: Boolean
Required: No
- firstName
-
The first name of the user.
Type: String
Pattern:
[\S\s]*Required: No
- inviteCode
-
A custom invite code for the user. If not provided, one will be generated automatically.
Type: String
Pattern:
[\S\s]*Required: No
- inviteCodeTtl
-
The time-to-live for the invite code in days. After this period, the invite code will expire.
Type: Integer
Required: No
- lastName
-
The last name of the user.
Type: String
Pattern:
[\S\s]*Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
