diff --git a/content/manuals/admin/company/manage.md b/content/manuals/admin/company/manage.md index 4b91db7a0e2b..427ef8494750 100644 --- a/content/manuals/admin/company/manage.md +++ b/content/manuals/admin/company/manage.md @@ -3,7 +3,7 @@ title: Manage your company linkTitle: Manage weight: 20 description: Learn how to manage your company, including its organizations, owners, and members, using Docker Home. -keywords: company, manage company, multiple organizations, company owners, company members, Docker Home, add organization, resend invites +keywords: company, manage company, multiple organizations, company owners, company members, Docker Home, add organization, resend invites, export users, CSV aliases: - /admin/company/manage/organizations/ - /admin/company/manage/owners/ @@ -104,6 +104,26 @@ To bulk resend invitations: you want to invite. 1. Select **Resend invites**, then choose **Resend** to confirm. +## Export users CSV file + +Company owners can export a CSV file of users across organizations in the +company. + +1. Sign in to [Docker Home](https://app.docker.com/) and select your company. +1. Select **Users**. +1. Select the **Download** icon. The CSV file downloads in your browser. + +The CSV file includes these fields: + +- Name: The user's name +- Username: The user's Docker ID +- Email: The user's email address +- Account Created: The time and date when the user account was created +- Member of Organizations: Organizations the user belongs to within the + company +- Invited to Organizations: Organizations the user is invited to within the + company + ## Add seats to an organization If you have a self-serve subscription that has no pending subscription changes, diff --git a/content/manuals/admin/organization/manage/members.md b/content/manuals/admin/organization/manage/members.md index 0b9361d0f4d6..3daef115a547 100644 --- a/content/manuals/admin/organization/manage/members.md +++ b/content/manuals/admin/organization/manage/members.md @@ -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,90 +48,84 @@ 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: @@ -146,57 +133,48 @@ 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,38 @@ 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. -## Export members CSV file +### Remove a member from the organization -{{< summary-bar feature_name="Admin orgs" >}} +Organization owners can remove members from the organization. Removing a +member revokes their access to the organization's resources and teams. -Owners can export a CSV file containing all members. The CSV file for a company -contains the following fields: +If your organization uses SSO with +[SCIM](/manuals/enterprise/security/provisioning/scim/_index.md) enabled, +remove members from your IdP instead. -- 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 +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. -To export a CSV file of your members: +## Export members CSV file + +Organization owners can export a CSV file of all members. Docker generates +the file asynchronously and emails it to the owner when it's ready. 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. +1. Select the **Download** icon to start the export. +1. Open the email from Docker and select the link to download the CSV file. + +The CSV file includes these fields: + +- Name: The user's name +- Username: The user's Docker ID +- Email: The user's email address +- Account Created: The time and date when the user account was created diff --git a/content/manuals/enterprise/security/single-sign-on/FAQs/users-faqs.md b/content/manuals/enterprise/security/single-sign-on/FAQs/users-faqs.md index a89bbe4ca5f8..62cb1d1f768e 100644 --- a/content/manuals/enterprise/security/single-sign-on/FAQs/users-faqs.md +++ b/content/manuals/enterprise/security/single-sign-on/FAQs/users-faqs.md @@ -37,7 +37,11 @@ For detailed instructions, see [Configure single sign-on](/manuals/enterprise/se ## Is Docker SSO fully synced with the IdP? -Docker SSO provides Just-in-Time (JIT) provisioning by default. Users are provisioned when they authenticate with SSO. If users leave the organization, administrators must manually [remove the user](/manuals/admin/organization/manage/members.md#remove-members-from-teams) from the organization. +Docker SSO provides Just-in-Time (JIT) provisioning by default. Users are +provisioned when they authenticate with SSO. If users leave the organization, +administrators must manually +[remove the user](/manuals/admin/organization/manage/members.md#remove-a-member-from-the-organization) +from the organization. [SCIM](/manuals/enterprise/security/provisioning/scim/_index.md) provides full synchronization with users and groups. When using SCIM, the recommended configuration is to turn off JIT so all auto-provisioning is handled by SCIM.