diff --git a/content/manuals/admin/organization/members.md b/content/manuals/admin/organization/members.md index 275e3069741..25d78ce890a 100644 --- a/content/manuals/admin/organization/members.md +++ b/content/manuals/admin/organization/members.md @@ -9,6 +9,8 @@ aliases: Learn how to manage members for your organization in Docker Hub and the Docker Admin Console. +## Invite members + {{< tabs >}} {{< tab name="Docker Hub" >}} @@ -24,18 +26,97 @@ Learn how to manage members for your organization in Docker Hub and the Docker A {{< /tab >}} {{< /tabs >}} +## Accept invitation + +When an invitation is to a user's email address, they receive +a link to Docker Hub where they can accept or decline the invitation. +To accept an invitation: + +1. Navigate to your email inbox and open the Docker email with an invitation to +join the Docker organization. +2. To open the link to Docker Hub, select the **click here** link. +3. The Docker create an account page will open. If you already have an account, select **Already have an account? Sign in**. +If you do not have an account yet, create an account using the same email +address you received the invitation through. +4. Optional. If you do not have an account and created one, you must navigate +back to your email inbox and verify your email address using the Docker verification +email. +5. Once you are signed in to Docker Hub, select **Organizations** from the top-level navigation menu. +6. The organizations page will display your invitation. Select **Accept**. + +After accepting an invitation, you are now a member of the organization. + +## Manage invitations + +After inviting members, you can resend or remove invitations as needed. + +### Resend an invitation + +{{< tabs >}} +{{< tab name="Docker Hub" >}} + +To resend an invitation from Docker Hub: + +1. Sign in to [Docker Hub](https://hub.docker.com/). +2. Select **Organizations**, your organization, and then **Members**. +3. In the table, locate the invitee, select the **Actions** icon, and then select +**Resend invitation**. +4. Select **Invite** to confirm. + +{{< /tab >}} +{{< tab name="Admin Console" >}} + +{{< include "admin-early-access.md" >}} + +To resend an invitation from the Admin Console: + +1. Open the [Admin Console](https://app.docker.com/admin) and select your organization from +top-left drop-down menu. +2. Select **Members**. +3. Select the **action menu** next to the invitee and select **Resend invitation**. +4. Select **Invite** to confirm. + +{{< /tab >}} +{{< /tabs >}} + +### Remove an invitation + +{{< tabs >}} +{{< tab name="Docker Hub" >}} + +To remove a member's invitation from Docker Hub: + +1. Sign in to [Docker Hub](https://hub.docker.com/). +2. Select **Organizations**, your organization, and then **Members**. +3. In the table, select the **Action** icon, and then select **Remove member** or **Remove invitee**. +4. Follow the on-screen instructions to remove the member or invitee. + +{{< /tab >}} +{{< tab name="Admin Console" >}} + +{{< include "admin-early-access.md" >}} + +To remove an invitation from the Admin Console: + +1. Open the [Admin Console](https://app.docker.com/admin) and select your organization from +top-left drop-down menu. +2. Select **Members**. +3. Select the **action menu** next to the invitee and select **Remove invitee**. +4. Select **Remove** to confirm. + +{{< /tab >}} +{{< /tabs >}} + ## Manage members on a team -Use Docker Hub to add a member to a team or remove a member from a team. +Use Docker Hub or the Admin Console to add or remove team members. Organization owners can add a member to one or more teams within an organization. ### Add a member to a team -Organization owners can add a member to one or more teams within an organization. - {{< tabs >}} {{< tab name="Docker Hub" >}} -To add a member to a team: +To add a member to a team with Docker Hub: 1. Sign in to [Docker Hub](https://hub.docker.com). 2. Select **Organizations**, your organization, and then **Members**. @@ -55,9 +136,9 @@ To add a member to a team: {{< include "admin-early-access.md" >}} -To add a member to a team: +To add a member to a team with the Admin Console: -1. In the Admin Console, select your organization. +1. In the [Admin Console](https://app.docker.com/admin), select your organization. 2. Select the team name. 3. Select **Add member**. You can add the member by searching for their email address or username. @@ -75,9 +156,7 @@ Organization owners can remove a member from a team in Docker Hub or Admin Conso {{< tabs >}} {{< tab name="Docker Hub" >}} -To add a member to a team: - -To remove a member from a specific team: +To remove a member from a specific team with Docker Hub: 1. Sign in to [Docker Hub](https://hub.docker.com). 2. Select **Organizations**, your organization, **Teams**, and then the team. @@ -89,12 +168,46 @@ To remove a member from a specific team: {{< include "admin-early-access.md" >}} -To remove a member from a specific team: +To remove a member from a specific team with the Admin Console: -1. In the Admin Console, select your organization. +1. In the [Admin Console](https://app.docker.com/admin), select your organization. 2. Select the team name. 3. Select the **X** next to the user's name to remove them from the team. 4. When prompted, select **Remove** to confirm. {{< /tab >}} {{< /tabs >}} + +### Update a member role + +Organization owners can manage [roles](/security/for-admins/roles-and-permissions/) +within an organization. If an organization is part of a company, +the company owner can also manage that organization's roles. If you have SSO enabled, you can use [SCIM for role mapping](/security/for-admins/provisioning/scim/). + +> [!NOTE] +> +> If you're the only owner of an organization, +> you need to assign a new owner before you can edit your role. + +To update a member role: + +1. Sign in to [Docker Hub](https://hub.docker.com). +2. Select **Organizations**, your organization, and then **Members**. +3. Find the username of the member whose role you want to edit. In the table, select the **Actions** icon. +4. Select **Edit role**. +5. Select their organization, select the role you want to assign, and then select **Save**. + +## Export members CSV file + +Owners can export a CSV file containing all members. The CSV file for a company contains the following fields: +- Name: The user's name +- Username: The user's Docker ID +- Email: The user's email address +- Member of Organizations: All organizations the user is a member of within a company +- Invited to Organizations: All organizations the user is an invitee of within a company +- Account Created: The time and date when the user account was created + +To export a CSV file of the members: +1. Sign in to [Docker Hub](https://hub.docker.com). +2. Select **Organizations**, your organization, and then **Members**. +3. Select the **Action** icon and then select **Export users as CSV**. \ No newline at end of file diff --git a/layouts/shortcodes/admin-users.html b/layouts/shortcodes/admin-users.html index 0439c898c9e..999d9286a9c 100644 --- a/layouts/shortcodes/admin-users.html +++ b/layouts/shortcodes/admin-users.html @@ -3,7 +3,6 @@ {{ $member_navigation := "Select **Organizations**, your organization, and then **Members**." }} {{ $remove_button := "**Remove member**" }} {{ $product_link := "[Docker Hub](https://hub.docker.com)" }} -{{ $update_role := "Select the role you want to assign, then select **Save**." }} {{ $role_mapping_link := "[SCIM for role mapping](/security/for-admins/provisioning/scim/)" }} {{ $export_fields := `The CSV file for an organization contains the following fields: * **Name**: The user's name. @@ -32,16 +31,13 @@ * **Account Created**: The time and date when the user account was created.` }} {{ $member_navigation = "Select your company in the left navigation drop-down menu, and then select **Users**." }} {{ $remove_button = "**Remove user**" }} -{{ $update_role = "Select their organization, select the role you want to assign, and then select **Save**." }} {{ $role_mapping_link = "[SCIM for role mapping](/security/for-admins/provisioning/scim/)"}} {{ end }} {{ end }} -## Invite members - -Owners can invite new members to an organization via Docker ID, email address, or via a CSV file containing email +Owners can invite new members to an organization via Docker ID, email address, or with a CSV file containing email addresses. If an invitee does not have a Docker account, they must create an account and verify their email address -before they can accept the invitation to join the organization. When inviting members, their pending invitation occupies +before they can accept an invitation to join the organization. When inviting members, their pending invitation occupies a seat. ### Invite members via Docker ID or email address @@ -56,7 +52,7 @@ 5. Follow the on-screen instructions to invite members. Invite a maximum of 1000 members and separate multiple entries by comma, semicolon, or space. - > **Note** + > [!NOTE] > > When you invite members, you assign them a role. > See [Roles and permissions](/security/for-admins/roles-and-permissions/) @@ -98,7 +94,7 @@ 7. Select **Browse files** and then select your CSV file, or drag and drop the CSV file into the **Select a CSV file to upload** box. You can only select one CSV file at a time. - > **Note** + > [!NOTE] > > If the amount of email addresses in your CSV file exceeds the number of available seats in your organization, you > cannot continue to invite members. To invite members, you can purchase more seats, or remove some email addresses from @@ -110,17 +106,17 @@ Valid email addresses and any email addresses that have issues appear. Email addresses may have the following issues: - - **Invalid email**: The email address is not a valid address. + - Invalid email: The email address is not a valid address. The email address will be ignored if you send invites. You can correct the email address in the CSV file and re-import the file. - - **Already invited**: The user has already been sent an invite email and another invite email will not be sent. - - **Member**: The user is already a member of your organization and an invite email will not be sent. - - **Duplicate**: The CSV file has multiple occurrences of the same email address. + - Already invited: The user has already been sent an invite email and another invite email will not be sent. + - Member: The user is already a member of your organization and an invite email will not be sent. + - Duplicate: The CSV file has multiple occurrences of the same email address. The user will be sent only one invite email. 9. Follow the on-screen instructions to invite members. - > **Note** + > [!NOTE] > > When you invite members, you assign them a role. > See [Roles and permissions](/security/for-admins/roles-and-permissions/) @@ -128,51 +124,3 @@ Pending invitations appear in the table. The invitees receive an email with a link to Docker Hub where they can accept or decline the invitation. - -## Resend invitations - -To resend an invitation if the invite is pending or declined: - -1. Sign in to {{ $product_link }}. -2. {{ $member_navigation }} -3. In the table, locate the invitee, select the **Action** icon, and then select **Resend invitation**. -4. Select **Invite** to confirm. - -## Remove a member or invitee - -To remove a member from an organization: - -1. Sign in to {{ $product_link }}. -2. {{ $member_navigation }} -3. In the table, select the **Action** icon, and then select {{ $remove_button }} or **Remove invitee**. -4. Follow the on-screen instructions to remove the member or invitee. - -## Update a member role - -Organization owners can manage [roles](/security/for-admins/roles-and-permissions/) -within an organization. If an organization is part of a company, -the company owner can also manage that organization's roles. If you have SSO enabled, you can use {{ $role_mapping_link }}. - -> **Note** -> -> If you're the only owner of an organization, -> you need to assign a new owner before you can edit your role. - -To update a member role: - -1. Sign in to {{ $product_link }}. -2. {{ $member_navigation }} -3. Find the username of the member whose role you want to edit. In the table, select the **Actions** icon. -4. Select **Edit role**. -5. {{ $update_role }} - -## Export members - -Owners can export a CSV file containing all members. -{{ $export_fields }} - -To export a CSV file of the members: - -1. Sign in to {{ $product_link }}. -2. {{ $member_navigation }} -3. Select {{ $export_button }}.