# User operations With user API operations, you can perform actions on Amazon Quick Sight account users. For more information, see the following API operations. **Topics** + [ # DeleteUser ](delete-user.md) + [ # DeleteUserByPrincipalTitle ](delete-user-by-principal-title.md) + [ # DescribeUser ](describe-user.md) + [ # ListUserGroups ](list-user-groups.md) + [ # ListUsers ](list-users.md) + [ # RegisterUser ](register-user.md) + [ # UpdateUser ](update-user.md) # DeleteUser Use the `DeleteUser` operation to delete the Quick Sight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call. To use this operation, you need the ID of the user that you want to delete. You can also use the `ListUsers` operation to list all users and their corresponding user IDs. Following is an example AWS CLI command for this operation. ------ #### [ AWS CLI ] ``` aws quicksight delete-user --user-name USERNAME --aws-account-id AWSACCOUNTID --namespace default ``` ------ For more information about the `DeleteUser` operation, see [DeleteUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DeleteUser.html) in the *Quick Sight API Reference*. # DeleteUserByPrincipalTitle The `DeleteUserByPrincipalTitle` operation deletes a user identified by a principal ID. Following is an example AWS CLI command for this operation. To use this operation, you need the ID of the user that you want to delete. You can also use the `ListUsers` operation to list all users and their corresponding user IDs. Following is an example AWS CLI command for this operation. ------ #### [ AWS CLI ] ``` aws quicksight delete-user-by-principal-id --principal-id PRINCIPALID --aws-account-id AWSACCOUNTID --namespace default ``` ------ For more information about the `DeleteUserByPrincipalTitle` operation, see [DeleteUserByPrincipalTitle](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DeleteUserByPrincipalTitle.html) in the *Quick Sight API Reference*. # DescribeUser Use the `DescribeUser` operation to return information about a user, given the user name. Following is an example AWS CLI command for this operation. To use this operation, you need the ID of the user that you want to describe. You can also use the `ListUsers` operation to list all users and their corresponding user IDs. Following is an example AWS CLI command for this operation. ------ #### [ AWS CLI ] ``` aws quicksight describe-user --aws-account-id AWSACCOUNTID --namespace default ``` ------ For more information about the `DescribeUser` operation, see [DescribeUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html) in the *Quick Sight API Reference*. # ListUserGroups Use the `ListUserGroups` operation to list the Quick Sight groups that an Quick Sight user is a member of. To use this operation, you need the ID of the user whose group memberships you want to know. You can use the `ListUsers` operation to list all users and their corresponding user IDs. Following is an example AWS CLI command for this operation. ------ #### [ AWS CLI ] ``` aws quicksight list-user-groups --user-name USERNAME --aws-account-id AWSACCOUNTID --namespace default --max-results 100 ``` ------ For more information about `ListUserGroups` operation, see [ListUserGroups](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ListUserGroups.html)in the *Quick Sight API Reference*. # ListUsers Use the `ListUsers` operation to return a list of all of the Quick Sight users belonging to this account. Following is an example AWS CLI command for this operation. ------ #### [ AWS CLI ] ``` aws quicksight list-users --aws-account-id AWSACCOUNTID --max-results 100 --namespace default ``` ------ For more information about `ListUsers` operation, see [ListUsers](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ListUsers.html) in the *Quick Sight API Reference*. # RegisterUser Use the `RegisterUser` operation to create an Quick Sight user whose identity is associated with the IAM identity or role specified in the request. When you register a new user from the Amazon Quick Sight API, Amazon Quick Sight generates a registration URL. The user accesses this registration URL to create their account. Amazon Quick Sight does not send a registration email to users who are registered from the Amazon Quick Sight API. Following is an example AWS CLI command for this operation. ------ #### [ AWS CLI ] ``` aws quicksight register-user --identity-type QUICKSIGHT --email EMAIL --user-role AUTHOR --iam-arn 222233334444 --session-name SESSION --aws-account-id AWSACCOUNTID --namespace default --user-name USERNAME --external-login-federation-provider-type CUSTOM_OIDC --custom-federation-provider-url www.example.com/ --external-login-id EXTERNALLOGINID ``` You can also make this command using a CLI skeleton file with the following command. For more information about CLI skeleton files, see [Use CLI skeleton files](cli-skeletons.md). ``` aws quicksight register-user --cli-input-json file://registeruser.json ``` ------ After using this operation, you get a response that includes a link labeled **Invitation URL**. Click the **Invitation URL** to set up a password and activate the new account. The new user then appear in the Quick Sight UI. You can use the `ListUsers` operation to list all users and their corresponding user IDs. For more information about `RegisterUser` operation, see [RegisterUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html)in the *Quick Sight API Reference*. # UpdateUser Use the `UpdateUser` operation to update an Quick Sight user. To use this operation, you need the ID of the user that you want to delete. You can use the `ListUsers` operation to list all users and their corresponding user IDs. Following is an example AWS CLI command for this operation. ------ #### [ AWS CLI ] ``` aws quicksight update-user --aws-account-id 555555555555 --username USERNAME --namespace NAMESPACE --email johndoe@example.com --role ROLE ``` You can also make this command using a CLI skeleton file with the following command. For more information about CLI skeleton files, see [Use CLI skeleton files](cli-skeletons.md). ``` aws quicksight update-user --cli-input-json file://updateuser.json ``` ------ For more information about `UpdateUser` operation, see [UpdateUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html)in the *Quick Sight API Reference*.