-
Notifications
You must be signed in to change notification settings - Fork 8.4k
docs(admin): freshness pass on organization members page #25669
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,27 +2,29 @@ | |
| title: Manage organization members | ||
| linkTitle: Members | ||
| weight: 10 | ||
| description: Learn how to manage organization members. | ||
| keywords: members, teams, organizations, invite members, manage team members, export member list, edit roles, organization teams, user management | ||
| description: Invite, manage, and export members for your Docker organization. | ||
| keywords: members, invite members, organization members, Docker Home, export | ||
| member list, edit roles, manage invitations, CSV invite, teams, remove members | ||
| aliases: | ||
| - /docker-hub/members/ | ||
| - /admin/organization/members/ | ||
| --- | ||
|
|
||
| Learn how to manage members for your organization. | ||
| Learn how to invite and manage members for your organization in Docker Home. | ||
|
|
||
| ## Invite members | ||
|
|
||
| Owners can invite new members to an organization via Docker ID, email address, | ||
| or with a CSV file containing email addresses. If an invitee doesn't have a | ||
| Docker account, they must create one and verify their email address before | ||
| they can accept an invitation to join the organization. When inviting members, | ||
| their pending invitation occupies a seat. | ||
| Owners can invite new members using a Docker ID, email address, or a CSV file | ||
| of email addresses. If an invitee doesn't have a Docker account, they must | ||
| create one and verify their email address before they can accept an invitation. | ||
| Pending invitations occupy a seat. | ||
|
|
||
| ### Invite members via Docker ID or email address | ||
| When you invite members, you assign them a role. See | ||
| [Roles and permissions](/manuals/enterprise/security/roles-and-permissions/_index.md) | ||
| for details about the access permissions for each role. | ||
|
|
||
| Use the following steps to invite members to your organization via Docker ID | ||
| or email address. | ||
| {{< tabs >}} | ||
| {{< tab name="Email or username" >}} | ||
|
|
||
| 1. Sign in to [Docker Home](https://app.docker.com) and select your | ||
| organization from the top-left account drop-down. | ||
|
|
@@ -31,17 +33,8 @@ or email address. | |
| 1. Follow the on-screen instructions to invite members. Invite a maximum of | ||
| 1000 members and separate multiple entries by comma, semicolon, or space. | ||
|
|
||
| When you invite members, you assign them a role. See | ||
| [Roles and permissions](/manuals/enterprise/security/roles-and-permissions/_index.md) | ||
| for details about the access permissions for each role. | ||
|
|
||
| Pending invitations appear in the table. Invitees receive an email with a link | ||
| to Docker Hub where they can accept or decline the invitation. | ||
|
|
||
| ### Invite members via CSV file | ||
|
|
||
| To invite multiple members to an organization via a CSV file containing email | ||
| addresses: | ||
| {{< /tab >}} | ||
| {{< tab name="CSV upload" >}} | ||
|
|
||
| 1. Sign in to [Docker Home](https://app.docker.com) and select your | ||
| organization from the top-left account drop-down. Select **Members** > | ||
|
|
@@ -55,148 +48,133 @@ addresses: | |
| docker.user-1@example.com | ||
| ``` | ||
|
|
||
| The example file demonstrates CSV file requirements: | ||
| - The file must contain a header row with at least one heading named email. | ||
| Additional columns are allowed and are ignored in the import. | ||
| CSV file requirements: | ||
| - The file must contain a header row with at least one heading named | ||
| `email`. Additional columns are allowed and are ignored in the import. | ||
| - The file must contain a maximum of 1000 email addresses (rows). To invite | ||
| more than 1000 users, create multiple CSV files and perform all steps in | ||
| this task for each file. | ||
| more than 1000 users, create multiple CSV files and complete this | ||
| procedure for each file. | ||
|
|
||
| 1. Create a new CSV file or export a CSV file from another application. | ||
| - To export a CSV file from another application, see the application’s | ||
| - To export a CSV file from another application, see that application's | ||
| documentation. | ||
| - To create a new CSV file, open a new file in a text editor, type email on | ||
| the first line, type the user email addresses one per line on the | ||
| following lines, and then save the file with a .csv extension. | ||
| 1. 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. | ||
| 1. After the CSV file has been uploaded, select **Review** to identify any | ||
| invalid email addresses, already invited users, invited users who are | ||
| already members, or duplicated email addresses within the same CSV file. | ||
| - To create a new CSV file, open a new file in a text editor, type `email` | ||
| on the first line, type one email address per line on the following | ||
| lines, then save the file with a `.csv` extension. | ||
|
|
||
| 1. Select **Browse files** and select your CSV file, or drag and drop the CSV | ||
| file into the **Select a CSV file to upload** box. You can select only one | ||
| CSV file at a time. | ||
| 1. After the CSV file uploads, select **Review** to identify invalid email | ||
| addresses, already invited users, users who are already members, or | ||
| duplicate email addresses in the same CSV file. | ||
| 1. Follow the on-screen instructions to invite members. | ||
|
|
||
| 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. | ||
|
|
||
| ### Invite members via API | ||
| {{< /tab >}} | ||
| {{< /tabs >}} | ||
|
|
||
| You can bulk invite members using the Docker Hub API. For more information, see | ||
| the [Bulk create invites](https://docs.docker.com/reference/api/hub/latest/#tag/invites/paths/~1v2~1invites~1bulk/post) | ||
| You can also bulk invite members with the Docker Hub API. For more | ||
| information, see the | ||
| [Bulk create invites](https://docs.docker.com/reference/api/hub/latest/#tag/invites/paths/~1v2~1invites~1bulk/post) | ||
| API endpoint. | ||
|
|
||
| ## Accept invitation | ||
| Pending invitations appear in the Members table. Invitees receive an email | ||
| with a link to Docker Hub where they can accept or decline the invitation. | ||
|
|
||
| After receiving an email invitation, users can access a link to Docker Hub | ||
| where they can accept or decline the invitation. | ||
| ## Accept an invitation | ||
|
|
||
| To accept an invitation: | ||
| After you receive an email invitation, open the link to Docker Hub to accept | ||
| or decline it. | ||
|
|
||
| 1. Check your email inbox and open the Docker email with an invitation to | ||
| join the Docker organization. | ||
| 1. To open the link to Docker Hub, select the link in the invitation email. | ||
| 1. Open the Docker invitation email and select the link to Docker Hub. | ||
| 1. The Docker account creation page opens. If you already have an account, | ||
| select **Already have an account? Sign in**. If you don't have an account, | ||
| create one using the same email address you received the invitation | ||
| through. | ||
| 1. Optional. If you don't have an account and created one, you must navigate | ||
| back to your email inbox and verify your email address using the Docker | ||
| verification email. | ||
| 1. Once you are signed in to Docker Hub, select **My Hub** from the top-level | ||
| create one using the same email address that received the invitation. | ||
| 1. Optional. If you created a new account, open your email inbox and verify | ||
| your email address using the Docker verification email. | ||
| 1. After you sign in to Docker Hub, select **My Hub** from the top-level | ||
| navigation menu. | ||
| 1. Select **Accept** on your invitation. | ||
|
|
||
| After accepting an invitation, you are now a member of the organization. | ||
| After you accept the invitation, you are a member of the organization. | ||
|
|
||
| Invitation email links expire after 14 days. If your email link has expired, | ||
| you can sign in to [Docker Hub](https://hub.docker.com/) with the email | ||
| address the link was sent to and accept the invitation from the | ||
| **Notifications** panel. | ||
| Invitation email links expire after 14 days. If your link has expired, sign in | ||
| to [Docker Hub](https://hub.docker.com/) with the email address the invitation | ||
| was sent to, then accept the invitation from the **Notifications** panel. | ||
|
|
||
| ## Manage invitations | ||
|
|
||
| After inviting members, you can resend or remove invitations as needed. Each | ||
| invitee occupies one seat, so if the amount of email addresses in your CSV | ||
| file exceeds the number of available seats in your organization, you won't be | ||
| able to invite more members. | ||
| After inviting members, you can resend or remove invitations. Each invitee | ||
| occupies one seat. If the number of email addresses in your CSV file exceeds | ||
| the number of available seats, you can't invite more members. | ||
|
|
||
| > [!TIP] | ||
| > | ||
| > Need to manage more than 1,000 team members? | ||
| > [Upgrade to Docker Business for unlimited user invites](https://www.docker.com/pricing?ref=Docs&refAction=DocsAdminMembers) | ||
| > and advanced role management. You can also | ||
| > [add seats](/manuals/admin/organization/manage/manage-seats.md) to your | ||
| > subscription. | ||
| > Need more seats for your organization? | ||
| > [Add seats](/manuals/admin/organization/manage/manage-seats.md) to your | ||
| > subscription, or see | ||
| > [Docker pricing](https://www.docker.com/pricing?ref=Docs&refAction=DocsAdminMembers) | ||
| > for plan options. | ||
|
|
||
| ### Resend an invitation | ||
|
|
||
| You can send individual invitations, or bulk invitations from the Admin | ||
| Console. | ||
| You can resend individual or bulk invitations from Docker Home. | ||
|
|
||
| To resend an individual invitation: | ||
|
|
||
| 1. Sign in to [Docker Home](https://app.docker.com/) and select your | ||
| organization. | ||
| 1. Select **Members**. | ||
| 1. Select the **action menu** next to the invitee and select **Resend**. | ||
| 1. Select the **Actions** menu next to the invitee, then **Resend**. | ||
| 1. Select **Invite** to confirm. | ||
|
|
||
| To bulk resend invitations: | ||
|
|
||
| 1. Sign in to [Docker Home](https://app.docker.com/) and select your | ||
| organization. | ||
| 1. Select **Members**. | ||
| 1. Use the **checkboxes** next to **Usernames** to bulk select users. | ||
| 1. Use the checkboxes next to **Usernames** to select invitees. | ||
| 1. Select **Resend invites**. | ||
| 1. Select **Resend** to confirm. | ||
|
|
||
| ### Remove an invitation | ||
|
|
||
| To remove an invitation: | ||
|
|
||
| 1. Sign in to [Docker Home](https://app.docker.com/) and select your | ||
| organization. | ||
| 1. Select **Members**. | ||
| 1. Select the **action menu** next to the invitee and select | ||
| **Remove invitee**. | ||
| 1. Select the **Actions** menu next to the invitee, then **Remove invitee**. | ||
| 1. Select **Remove** to confirm. | ||
|
|
||
| ## Manage members on a team | ||
|
|
||
| Use Docker Hub or Docker Home to add or remove team members. | ||
| Organization owners can add a member to one or more teams within an | ||
| organization. | ||
| Use Docker Hub or Docker Home 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 | ||
|
|
||
| To add a member to a team: | ||
|
|
||
| 1. Sign in to [Docker Home](https://app.docker.com/) and select your | ||
| organization. | ||
| 1. Select **Teams**. | ||
| 1. Select the team name. | ||
| 1. Select **Add member**. You can add the member by searching for their email | ||
| address or username. | ||
| 1. Select **Add member**. Search for the member by email address or username. | ||
|
|
||
| An invitee must first accept the invitation to join the organization before | ||
| being added to the team. | ||
| An invitee must accept the organization invitation before you can add them to | ||
| a team. | ||
|
|
||
| ### Remove members from teams | ||
|
|
||
| If your organization uses single sign-on (SSO) with | ||
| [SCIM](/manuals/enterprise/security/provisioning/scim/_index.md) enabled, you | ||
| should remove members from your identity provider (IdP). This automatically | ||
| removes members from Docker. If SCIM is disabled, follow procedures in this | ||
| doc to remove members manually in Docker. | ||
| [SCIM](/manuals/enterprise/security/provisioning/scim/_index.md) enabled, | ||
| remove members from your identity provider (IdP). That removes them from | ||
| Docker automatically. If SCIM is disabled, remove members manually in Docker | ||
| using the following steps. | ||
|
|
||
| Organization owners can remove a member from a team. Removing the member from | ||
| the team revokes their access to the permitted resources. To remove a member | ||
| from a specific team: | ||
| Removing a member from a team revokes their access to that team's permitted | ||
| resources. | ||
|
|
||
| 1. Sign in to [Docker Home](https://app.docker.com/) and select your | ||
| organization. | ||
| 1. Select **Teams**, then choose the name of the team member you want to | ||
| remove. | ||
| 1. Select **Teams**, then select the team. | ||
| 1. Select the **X** next to the user's name to remove them from the team. | ||
| 1. When prompted, select **Remove** to confirm. | ||
|
|
||
|
|
@@ -205,10 +183,8 @@ from a specific team: | |
| Organization owners can manage | ||
| [roles](/manuals/enterprise/security/roles-and-permissions/_index.md) 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](/manuals/enterprise/security/provisioning/scim/_index.md). | ||
|
|
||
| To update a member role: | ||
| can also manage that organization's roles. If SSO is enabled, you can use | ||
| [SCIM for role mapping](/manuals/enterprise/security/provisioning/scim/_index.md). | ||
|
|
||
| 1. Sign in to [Docker Home](https://app.docker.com/) and select your | ||
| organization. | ||
|
|
@@ -217,27 +193,44 @@ To update a member role: | |
| **Actions** menu, then **Edit role**. | ||
|
|
||
| If you're the only owner of an organization and you want to edit your role, | ||
| assign a new owner for your organization so you can edit your role. | ||
| assign a new owner first so you can change your own role. | ||
|
|
||
| ### Remove a member from the organization | ||
|
|
||
| Organization owners can remove members from the organization. Removing a | ||
| member revokes their access to the organization's resources and teams. | ||
|
|
||
| If your organization uses SSO with | ||
| [SCIM](/manuals/enterprise/security/provisioning/scim/_index.md) enabled, | ||
| remove members from your IdP instead. | ||
|
|
||
| 1. Sign in to [Docker Home](https://app.docker.com/) and select your | ||
| organization. | ||
| 1. Select **Members**. | ||
| 1. Find the username of the member you want to remove. Select the | ||
| **Actions** menu, then **Remove member**. | ||
| 1. Select **Remove** to confirm. | ||
|
|
||
| ## Export members CSV file | ||
|
|
||
| {{< summary-bar feature_name="Admin orgs" >}} | ||
| Owners of Docker Team or Business organizations can export a CSV file of all members. Docker generates the file | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LOW] Long unwrapped prose line (111 chars) This line is 111 characters — longer than the ~80-char soft wrap used throughout the rest of the file. The sentence continues on the next line, making the paragraph read as a run-on in raw Markdown. Consider wrapping: Owners of Docker Team or Business organizations can export a CSV file of all
members. Docker generates the file asynchronously and emails it to the owner
when it's ready.There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We don't restrict it to Team or Business, any org can export |
||
| asynchronously and emails it to the owner when it's ready. | ||
|
|
||
| Owners can export a CSV file containing all members. The CSV file for a company | ||
| contains the following fields: | ||
| 1. Sign in to [Docker Home](https://app.docker.com/) and select your | ||
| organization. | ||
| 1. Select **Members**. | ||
| 1. Select the **Download** icon to start the export. | ||
|
|
||
| Organization and company CSV files include these 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 your members: | ||
| Company CSV files include two additional fields: | ||
|
|
||
| 1. Sign in to [Docker Home](https://app.docker.com/) and select your | ||
| organization. | ||
| 1. Select **Members**. | ||
| 1. Select the **download** icon to export a CSV file of all members. | ||
| - Member of Organizations: Organizations the user belongs to within the | ||
| company | ||
| - Invited to Organizations: Organizations the user is invited to within the | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LOW] Missing newline at end of file The diff shows |
||
| company | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [LOW] Missing newline at end of file The file ends without a trailing newline ( |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[MEDIUM]
summary-barshortcode removed — "Administrators only" constraint may be lostThe
{{< summary-bar feature_name="Admin orgs" >}}shortcode rendered two metadata fields (fromdata/summary.yaml):The replacement prose — "Owners of Docker Team or Business organizations can export a CSV file" — captures the subscription tier but doesn't convey the Administrators-only scope. If this restriction still applies, consider adding a note such as: "Only organization owners can export the member list."