UpdateUserDetails
Contains the modifiable details for updating an existing user, including name, password, security group membership, and invitation settings.
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.
Contents
Note
In the following list, the required parameters are described first.
- codeValidation
-
Indicates whether the user can be verified through a custom invite code.
Type: Boolean
Required: No
- firstName
-
The new first name for the user.
Type: String
Pattern:
[\S\s]*Required: No
- inviteCode
-
A new custom invite code for the user.
Type: String
Pattern:
[\S\s]*Required: No
- inviteCodeTtl
-
The new time-to-live for the invite code in days.
Type: Integer
Required: No
- lastName
-
The new last name for the user.
Type: String
Pattern:
[\S\s]*Required: No
- securityGroupIds
-
The updated list of security group IDs to which the user should belong.
Type: Array of strings
Pattern:
[\S]+Required: No
- username
-
The new username or email address for 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:
