Skip to content

chore:update user management #5234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added public/images/studio/auth/create-user.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/studio/auth/user-groups.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/images/studio/auth/user-management.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
69 changes: 38 additions & 31 deletions src/pages/console/auth/user-management.mdx
Original file line number Diff line number Diff line change
@@ -1,48 +1,55 @@
export const meta = {
title: `Manage authentication for users and groups`,
description: `Manage authentication for users and groups`,
description: `Manage authentication for users and groups`
};

In Amplify Studio, you can create and manage users and groups, edit user attributes, and suspend users.

This topic shows you how to create and manage your app's users and groups. To set authorization rules that allow these users and groups to perform create, read, update, or delete operations on your app data, see [Authorization](/console/authz/authorization).
To set authorization rules that allow these users and groups to perform create, read, update, or delete operations on your app data, see [Authorization](/console/authz/authorization).

![user management](/images/studio/auth/user-management.png)

## To create a user
1. Open Studio for an app.
2. On the **Manage** menu, choose **User management**.
3. On the **User management** page, choose the **Users** tab and then choose **Create user**.
4. In the **Create user** window, for **Unique identifier** enter a username, email address, or phone number. For **Temporary password** enter a password.
5. Choose **Create user**.

![create user](/images/studio/auth/create-user.png)

1. On the **Manage** menu, choose **User management**.
2. On the **User management** page, choose the **Users** tab and then choose **Create user**.
3. In the **Create user** window, for **Unique identifier** enter a username, email address, or phone number. For **Temporary password** enter a password.
4. Choose **Create user**.

<Callout>

A user can be confirmed by using the [pre-built UI components](/lib/auth/getting-started/q/platform/js/#enable-sign-up-sign-in-and-sign-out), [Amplify libraries](https://aws-amplify.github.io/amplify-js/api/classes/authclass.html) or [AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/confirm-sign-up.html)

</Callout>

## To modify access for a user
1. Open Studio for an app.
2. On the **Manage** menu, choose **User management**.
3. On the **User management** page, choose the **Users** tab.
4. Select the name of the user to manage.
5. On the **Actions** menu, choose the action to perform on the user. The options are **Reset password**, **Delete**, **Suspend**, or **Reactivate**.
6. For each menu option, a confirmation window is displayed. Follow the instructions in the confirmation window to complete the action on the user.

1. On the **User management** page, choose the **Users** tab.
2. Select the name of the user to manage.
3. On the **Actions** menu, choose the action to perform on the user. The options are **Reset password**, **Delete**, **Suspend**, or **Reactivate**.
4. For each menu option, a confirmation window is displayed. Follow the instructions in the confirmation window to complete the action on the user.

## To create a group
1. Open Studio for an app.
2. On the **Manage** menu, choose **User management**.
3. On the **User management** page, choose the **Groups** tab and then choose **Create group**.
4. In the **Create group** window, for **Title** enter a name for the group.
5. Choose **Create group**.

![Groups](/images/studio/auth/user-groups.png)

1. On the **User management** page, choose the **Groups** tab and then choose **Create group**.
2. In the **Create group** window, for **Title** enter a name for the group.
3. Choose **Create group**.

## To add a user to a group
1. Open Studio for an app.
2. On the **Manage** menu, choose **User management**.
3. On the **User management** page, choose the **Groups** tab.
4. Select the name of the group to add users to.
5. Choose **Add user(s)**.
6. In the **Add users to group** window, choose how you want to search for users to add from the **Search** menu. You can choose *Email*, *Phone number*, or *Username*.
7. Choose one user or multiple users to add to the group and then choose **Add users**.

1. On the **User management** page, choose the **Groups** tab.
2. Select the name of the group to add users to.
3. Choose **Add user(s)**.
4. In the **Add users to group** window, choose how you want to search for users to add from the **Search** menu. You can choose _Email_, _Phone number_, or _Username_.
5. Choose one user or multiple users to add to the group and then choose **Add users**.

## To delete a group
1. Open Studio for an app.
2. On the **Manage** menu, choose **User management**.
3. On the **User management** page, choose the **Groups** tab.
4. In the **Groups** section, select the name of the group to delete.
5. Choose **Delete**.
6. A confirmation window is displayed. Enter *Delete* and choose, **Confirm deletion**.

1. On the **User management** page, choose the **Groups** tab.
2. In the **Groups** section, select the name of the group to delete.
3. Choose **Delete**.
4. A confirmation window is displayed. Enter _Delete_ and choose, **Confirm deletion**.