diff --git a/content/manuals/admin/_index.md b/content/manuals/admin/_index.md index a01bd2f87330..fa680b792ac1 100644 --- a/content/manuals/admin/_index.md +++ b/content/manuals/admin/_index.md @@ -1,7 +1,7 @@ --- title: Administration -description: Overview of administration features and roles in the Docker Admin Console -keywords: admin, administration, company, organization, Admin Console, user accounts, account management +description: Overview of administration features and roles in Docker Home +keywords: admin, administration, company, organization, Docker Home, user accounts, account management weight: 10 params: sidebar: @@ -19,54 +19,56 @@ grid: description: Learn how to onboard and secure your organization. icon: magnifying-glass-plus link: /admin/organization/setup/onboard - - title: Company FAQ - description: Discover common questions and answers about companies. - icon: question-mark-circle - link: /faq/admin/company-faqs/ - - title: Organization FAQ - description: Explore popular FAQ topics about organizations. - icon: question-mark-circle - link: /faq/admin/organization-faqs/ - title: Security description: Explore security features for administrators. icon: shield-check - link: /security/ + link: /enterprise/security/ aliases: - /docker-hub/admin-overview --- -Administrators can manage companies and organizations using the -[Docker Admin Console](https://app.docker.com/admin). The Admin Console -provides centralized observability, access management, and security controls -across Docker environments. +Organization and company owners can manage members, control access, and enforce +security across their Docker environments. You perform these tasks in Docker +Home, which provides centralized observability, access management, and security +controls. + +As an organization or company owner, you can: + +- Create and manage companies and organizations +- Assign roles and permissions to members +- Group members into teams to manage access by project or role +- Set company-wide policies, including SCIM provisioning and security + enforcement ## Company and organization hierarchy -The [Docker Admin Console](https://app.docker.com/admin) provides administrators with centralized observability, access management, and controls for their company and organizations. To provide these features, Docker uses the following hierarchy and roles. +To provide centralized administration, Docker organizes companies and +organizations into the following hierarchy and roles. ![Diagram showing Docker’s administration hierarchy with Company at the top, followed by Organizations, Teams, and Members](./images/docker-admin-structure.webp) ### Company -A company groups multiple Docker organizations for centralized configuration. Companies have the company owner administrator role available. - -The company owner: - -- Can view and manage all organizations within the company -- Has full access to company-wide settings and inherits the same permissions as organization owners -- Does not occupy a seat +A company groups multiple Docker organizations for centralized configuration. A +company owner can view and manage every organization in the company and its +company-wide settings, with the same access rights as an organization owner. For +the company owner role and how it affects seats, see +[Company roles](/manuals/admin/company/_index.md#company-roles). Companies are only available for Docker Business subscribers. ### Organization -Organization owners have the organization owner administrator role available. They can manage organization settings, users, and access controls, but occupy a [seat](/manuals/admin/organization/organization-faqs.md#what-is-the-difference-between-user-invitee-seat-and-member). +An organization sits below the company and is where you group teams and +members and assign access to repositories. Every Docker Team and Business +subscriber has at least one organization. -- An organization contains teams and repositories. -- All Docker Team and Business subscribers must have at least one organization. +Organization owners hold the organization owner administrator role and manage +organization settings, users, and access controls. Each owner occupies a +[seat](/manuals/admin/organization/organization-faqs.md#what-is-the-difference-between-user-invitee-seat-and-member). -> [!TIP] -> [Upgrading to a Docker Business plan](https://www.docker.com/pricing?ref=Docs&refAction=DocsAdmin) grants you the company owner role so you can manage multiple organizations. +[Upgrading to a Docker Business plan](https://www.docker.com/pricing?ref=Docs&refAction=DocsAdmin) +grants you the company owner role so you can manage multiple organizations. ### Team @@ -79,17 +81,7 @@ or functions. A member is any Docker user added to an organization. Organization and company owners can assign roles to members to define their level of access. -## Admin Console features - -Docker's [Admin Console](https://app.docker.com/admin) allows you to: - -- Create and manage companies and organizations -- Assign roles and permissions to members -- Group members into teams to manage access by project or role -- Set company-wide policies, including SCIM provisioning and security - enforcement - -## Manage companies and organizations +## What's next Learn how to manage companies and organizations in the following sections. diff --git a/content/manuals/admin/company/_index.md b/content/manuals/admin/company/_index.md index 4a8dd4eef229..1208b3bcdadf 100644 --- a/content/manuals/admin/company/_index.md +++ b/content/manuals/admin/company/_index.md @@ -3,36 +3,20 @@ title: Company overview linkTitle: Company weight: 20 description: Learn how to manage multiple organizations using companies, including managing users, owners, and security. -keywords: company, multiple organizations, manage companies, admin console, Docker Business settings +keywords: company, multiple organizations, manage companies, Docker Home, Docker Business settings grid: - title: Create a company description: Get started by learning how to create a company. icon: building-office-2 link: /admin/company/new-company/ - - title: Manage organizations - description: - Learn how to add and manage organizations as well as seats within your - company. + - title: Manage your company + description: Add organizations, manage company owners, and invite members. icon: building-storefront - link: /admin/company/manage/organizations/ - - title: Manage company owners - description: Find out more about company owners and how to manage them. - icon: user-group - link: /admin/company/manage/owners/ - - title: Manage users - description: Explore how to manage users in all organizations. - icon: user-plus - link: /admin/company/manage/users/ - - title: Configure single sign-on - description: Discover how to configure SSO for your entire company. + link: /admin/company/manage/ + - title: Configure SSO and SCIM + description: Set up single sign-on and SCIM provisioning for your company. icon: key link: /enterprise/security/single-sign-on/ - - title: Set up SCIM - description: - Set up SCIM to automatically provision and deprovision users in your - company. - icon: clipboard-document-check - link: /enterprise/security/provisioning/scim/ - title: Domain management description: Add and verify your company's domains. icon: check-badge @@ -47,29 +31,40 @@ aliases: {{< summary-bar feature_name="Company" >}} -A company provides a single point of visibility across multiple organizations, -simplifying organization and settings management. - +A company provides a single point of visibility across multiple +organizations, for centralized organization and settings management. Organization owners with a Docker Business subscription can create a company -and manage it through the [Docker Admin Console](https://app.docker.com/admin). +and manage it through Docker Home. + +## Company structure The following diagram shows how a company relates to its associated organizations. ![Diagram showing how companies relate to Docker organizations](/admin/images/docker-admin-structure.webp) -## Key features +For the full administration hierarchy, see the +[administration overview](/manuals/admin/_index.md#company-and-organization-hierarchy). + +## Company roles + +A company includes one or more company owners. The creator of a company +becomes both a company owner and an organization owner, and occupies a seat +as organization owner. After creation, a company can have multiple owners, +and each owner has visibility across the entire company. They can manage +settings for every organization under it and have the same access rights as +organization owners. -With a company, administrators can: +- A company can have up to ten unique company owners. +- Company owners don't occupy a seat unless one of the following applies: + - They're added as a member of an organization under the company. + - SSO is enabled and the company owner signs in through SSO, which + automatically adds them as an organization member. -- View and manage all nested organizations -- Configure company and organization settings centrally -- Control access to the company -- Have up to ten unique users assigned to the company owner role -- Configure SSO and SCIM for all nested organizations -- Enforce SSO for all users in the company +To add or remove company owners, see +[Manage your company](/manuals/admin/company/manage.md#company-owners). -## Create and manage your company +## What's next Learn how to create and manage a company in the following sections. diff --git a/content/manuals/admin/company/company-faqs.md b/content/manuals/admin/company/company-faqs.md index ef88e17bd990..8ab054c97ce7 100644 --- a/content/manuals/admin/company/company-faqs.md +++ b/content/manuals/admin/company/company-faqs.md @@ -2,7 +2,7 @@ title: Company FAQs linkTitle: FAQs weight: 30 -description: Company FAQs +description: Frequently asked questions about Docker companies, including subscriptions, seats, company owners, and permissions. keywords: Docker, Docker Hub, SSO FAQs, single sign-on, company, administration, company management tags: [FAQ] aliases: @@ -14,37 +14,36 @@ aliases: ### Some of my organizations don’t have a Docker Business subscription. Can I still use a parent company? Yes, but you can only add organizations with a Docker Business subscription -to a company. +to a company. For more details, see [Add more organizations](/manuals/admin/company/manage.md#add-more-organizations). ### What happens if one of my organizations downgrades from Docker Business, but I still need access as a company owner? -To access and manage child organizations, the organization must have a -Docker Business subscription. If the organization isn’t included in this -subscription, the owner of the organization must manage the organization -outside of the company. +To access and manage a nested organization, it must have a Docker Business +subscription. If an organization downgrades from Docker Business, its owner must +manage it outside of the company. For more details, see +[Add more organizations](/manuals/admin/company/manage.md#add-more-organizations). ### Do company owners occupy a subscription seat? -Company owners do not occupy a seat unless one of the following is true: +Company owners don't occupy a seat unless one of the following is true: - They are added as a member of an organization under your company -- SSO is enabled and the company owner signs in via SSO, which automatically adds them as an organization member - -Although company owners have the same access as organization owners across all -organizations in the company, it's not necessary to add them to any -organization. Doing so will cause them to occupy a seat. +- SSO is enabled and the company owner signs in through SSO, which + automatically adds them as an organization member When you first create a company, your account is both a company owner and an -organization owner. In that case, your account will occupy a seat as long as -you remain an organization owner. - -To avoid occupying a seat, [assign another user as the organization owner](/manuals/admin/organization/manage/members.md#update-a-member-role) and remove yourself from the organization. -You'll retain full administrative access as a company owner without using a -subscription seat. +organization owner, so it occupies a seat as long as you remain an organization +owner. To free up that seat, +[assign another user as the organization owner](/manuals/admin/organization/manage/members.md#update-a-member-role) +and remove yourself from the organization. You keep full administrative access +as a company owner without using a subscription seat. ### What permissions does the company owner have in the associated/nested organizations? Company owners can navigate to the **Organizations** page to view all their -nested organizations in a single location. They can also view or edit organization members and change single sign-on (SSO) and System for Cross-domain Identity Management (SCIM) settings. Changes to company settings impact all users in each organization under the company. +nested organizations in a single location. They can also view or edit +organization members and change single sign-on (SSO) and System for +Cross-domain Identity Management (SCIM) settings. Changes to company settings +impact all users in each organization under the company. For more information, see [Roles and permissions](/manuals/enterprise/security/roles-and-permissions.md). diff --git a/content/manuals/admin/company/manage.md b/content/manuals/admin/company/manage.md new file mode 100644 index 000000000000..4b91db7a0e2b --- /dev/null +++ b/content/manuals/admin/company/manage.md @@ -0,0 +1,121 @@ +--- +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 +aliases: + - /admin/company/manage/organizations/ + - /admin/company/manage/owners/ + - /admin/company/manage/users/ + - /admin/company/organizations/ + - /admin/company/owners/ + - /admin/company/users/ + - /docker-hub/company-owner/ +--- + +{{< summary-bar feature_name="Company" >}} + +After creating a company, you can manage multiple organizations from Docker +Home. Company owners can use the company portal to invite users to specific +organizations, view seat availability across organizations, and add new +company owners. + +## Add more organizations + +Company owners can add Docker organizations with a Docker Business plan to +their company, so long as they're also the organization owners for that +organization. There's no limit to the number of organizations you add to a +company. + +> [!IMPORTANT] +> +> Once you add an organization to a company, you can't remove it from the +> company. + +1. Sign in to [Docker Home](https://app.docker.com) and select + your company. +1. Select **Managed organizations**. +1. Select **Add organization**, then choose an organization from the dropdown. + +A nested organization must keep its Docker Business subscription to stay managed +by the company. If an organization downgrades from Docker Business, you can no +longer manage it through the company, and its owner must manage it separately. + +## Company owners + +A company can have multiple owners who manage the company and all of its +organizations. For details about the company owner role and how it affects +seats, see [Company roles](/manuals/admin/company/_index.md#company-roles). + +### Add a company owner + +1. Sign in to [Docker Home](https://app.docker.com) and select your company. +1. Select **Company owners**, then choose **Add owner**. +1. Specify the user's Docker ID, then finish by selecting **Add company owner**. + +### Remove a company owner + +1. Sign in to [Docker Home](https://app.docker.com) and select your company. +1. Select **Company owners**. +1. Find the company owner you want to remove and select the **Actions** menu, + then choose **Remove as company owner**. + +## Company invitations + +You add a user to your company by inviting them to an organization within the +company. Company owners can invite members to any organization in the company +using a Docker ID, email address, or in bulk with a CSV file of email addresses. + +Members and invitations belong to individual organizations, not to the company +itself. A pending invitation occupies a seat in the organization the user is +invited to. + +### Invite members to an organization + +1. Sign in to [Docker Home](https://app.docker.com) and select your company. +1. Select **Users**, then choose **Invite**. +1. Choose how you want to invite members: + - To invite individual users, select **Emails or usernames**. + - To invite groups of users, select **CSV upload**. +1. Add user(s) to an organization by choosing **Select an organization**. + +Users receive invitations in their email with instructions to accept the +invitation. After accepting the invitation, new members appear on the +**Users** page. The table specifies how many organizations they're members of. + +### Resend invitations + +Company owners can resend invitations from the company-level **Users** page. +To resend individual invitations: + +1. Select your company from [Docker Home](https://app.docker.com/). +1. Select **Users**, then locate the invitee from the users table. +1. Select the **Actions** menu, then choose **Resend**. + - Before resending, confirm you are resending the invitation to the correct + invitee. + - The resend invitation modal displays the date you originally invited the + invitee. +1. Choose **Invite** to confirm. + +To bulk resend invitations: + +1. From the users table, use the multi-select checkboxes next to the invitees + you want to invite. +1. Select **Resend invites**, then choose **Resend** to confirm. + +## Add seats to an organization + +If you have a self-serve subscription that has no pending subscription changes, +you can add seats using Docker Home. For more information about adding seats, +see [Manage seats](/manuals/admin/organization/manage/manage-seats.md#add-seats-to-your-subscription). + +If you have a sales-assisted subscription, you must contact Docker support or +sales to add seats. + +## Manage teams + +Teams exist at the organization level, not the company level. After inviting +members to an organization, you can add them to teams within that organization. +For more details, see +[Manage members on a team](/manuals/admin/organization/manage/members.md#manage-members-on-a-team). diff --git a/content/manuals/admin/company/manage/_index.md b/content/manuals/admin/company/manage/_index.md deleted file mode 100644 index 026a74431255..000000000000 --- a/content/manuals/admin/company/manage/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -build: - render: never -title: Manage -weight: 20 ---- diff --git a/content/manuals/admin/company/manage/organizations.md b/content/manuals/admin/company/manage/organizations.md deleted file mode 100644 index 55b2f87225e5..000000000000 --- a/content/manuals/admin/company/manage/organizations.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Manage company organizations -linkTitle: Organizations -description: Learn how to manage organizations in a company. -keywords: company, multiple organizations, manage organizations, Docker Admin Console, organization settings, add organization, company management -aliases: - - /admin/company/organizations/ ---- - -{{< summary-bar feature_name="Company" >}} - -Learn to manage the organizations in a company using the Docker Admin Console. - -## View all organizations - -1. Sign in to the [Docker Home](https://app.docker.com) and choose - your company. -1. Select **Managed organizations**. - -The **Organizations** view displays all organizations under your company. - -## Add seats to an organization - -If you have a self-serve subscription that has no pending subscription changes, -you can add seats using Docker Home. For more information about adding seats, -see [Manage seats](/manuals/admin/organization/manage/manage-seats.md#add-seats-to-your-subscription). - -If you have a sales-assisted subscription, you must contact Docker support or -sales to add seats. - -## Add organizations to a company - -To add an organization to a company, ensure the following: - -- You are a company owner. -- You are an organization owner of the organization you want to add. -- The organization has a Docker Business subscription. -- There’s no limit to how many organizations can exist under a company. - -> [!IMPORTANT] -> -> Once you add an organization to a company, you can't remove it from the -> company. - -1. Sign in to [Docker Home](https://app.docker.com) and select your company from - the top-left account drop-down. -1. Select **Managed organizations**. -1. Select **Add organization**. -1. Choose the organization you want to add from the drop-down menu. -1. Select **Add organization** to confirm. - -## Manage an organization - -1. Sign in to [Docker Home](https://app.docker.com) and select your company from - the top-left account drop-down. -1. Select **Managed organizations**. -1. Select the organization you want to manage. - -For more details about managing an organization, see -[Organization administration](../../organization/_index.md). - -## More resources - -- [Video: Managing a company and nested organizations](https://youtu.be/XZ5_i6qiKho?feature=shared&t=229) -- [Video: Adding nested organizations to a company](https://youtu.be/XZ5_i6qiKho?feature=shared&t=454) diff --git a/content/manuals/admin/company/manage/owners.md b/content/manuals/admin/company/manage/owners.md deleted file mode 100644 index 2791ebdf0fea..000000000000 --- a/content/manuals/admin/company/manage/owners.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Manage company owners -linkTitle: Owners -description: Learn how to add and remove company owners. -keywords: company, owners, add company owner, remove company owner, company management, company owner permissions -aliases: - - /admin/company/owners/ - - /docker-hub/company-owner/ ---- - -{{< summary-bar feature_name="Company" >}} - -A company can have multiple owners. Company owners have visibility across the -entire company and can manage settings that apply to all organizations under -that company. They also have the same access rights as organization owners but -don’t need to be members of any individual organization. - -> [!IMPORTANT] -> -> Company owners do not occupy a seat unless they are added as a member of an -> organization under your company, or SSO is enabled and the company owner signs -> in via SSO (which automatically adds them as an organization member). - -## Add a company owner - -1. Sign in to [Docker Home](https://app.docker.com) and select your company from - the top-left account drop-down. -1. Select **Company owners**. -1. Select **Add owner**. -1. Specify the user's Docker ID to search for the user. -1. After you find the user, select **Add company owner**. - -## Remove a company owner - -1. Sign in to [Docker Home](https://app.docker.com) and select your company from - the top-left account drop-down. -1. Select **Company owners**. -1. Locate the company owner you want to remove and select the **Actions** menu. -1. Select **Remove as company owner**. diff --git a/content/manuals/admin/company/manage/users.md b/content/manuals/admin/company/manage/users.md deleted file mode 100644 index e029cdd0c36c..000000000000 --- a/content/manuals/admin/company/manage/users.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: Manage company members -linkTitle: Users -description: Learn how to invite and manage members in the organizations within your company using the Docker Admin Console. -keywords: company, company members, members, admin, Admin Console, member management, organization management, company management, bulk invite, resend invites -aliases: - - /admin/company/users/ ---- - -{{< summary-bar feature_name="Company" >}} - -Add a user to your company by inviting them to be a member of a company organization. Company owners can invite new members to an organization via Docker ID, -email address, or in bulk 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 an invitation to join the -organization. Pending invitations occupy seats for the organization -the user is invited to. - -## Invite members via Docker ID or email address - -Use the following steps to invite members to your organization via Docker ID or -email address. - -1. Sign in to [Docker Home](https://app.docker.com) and select - your company. -1. On the **Organizations** page, select the organization you want - to invite members to. -1. Select **Members**, then **Invite**. -1. Select **Emails or usernames**. -1. Follow the on-screen instructions to invite members. - Invite a maximum of 1000 members and separate multiple entries by comma, - semicolon, or space. - - > [!NOTE] - > - > When you invite members, you assign them a role. - > See [Roles and permissions](/manuals/enterprise/security/roles-and-permissions/core-roles.md) - > for details about the access permissions for each role. - - Pending invitations appear on the Members page. The 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: - -1. Sign in to [Docker Home](https://app.docker.com) and select - your company. -1. On the **Organizations** page, select the organization you want - to invite members to. -1. Select **Members**, then **Invite**. -1. Select **CSV upload**. -1. Select **Download the template CSV file** to optionally download an example - CSV file. The following is an example of the contents of a valid CSV file. - - ```text - email - docker.user-0@example.com - docker.user-1@example.com - ``` - - 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. - -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 - 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. - - > [!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 the CSV file and re-select the new file. To purchase more - > seats, see [Add seats to your subscription](/manuals/admin/organization/manage/manage-seats.md#add-seats-to-your-subscription) or - > Contact sales. - -1. After the CSV file has been uploaded, select **Review**. - - Valid email addresses and any email addresses that have issues will appear. - Email addresses may have the following issues: - - 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. - The user will be sent only one invite email. - -1. Follow the on-screen instructions to invite members. - - > [!NOTE] - > - > When you invite members, you assign them a role. - > See [Roles and permissions](/manuals/enterprise/security/roles-and-permissions/core-roles.md) - > for details about the access permissions for each role. - -Pending invitations appear on the Members page. The invitees receive an email -with a link to Docker Hub where they can accept or decline the invitation. - -## Resend invitations to users - -You can resend individual invitations, or bulk invitations from the Admin Console. - -### Resend individual invitations - -1. In [Docker Home](https://app.docker.com/), select your company from - the top-left account drop-down. -2. Select **Users**. -3. Select the **action menu** next to the invitee and select **Resend**. -4. Select **Invite** to confirm. - -### Bulk resend invitation - -1. In [Docker Home](https://app.docker.com/), select your company from - the top-left account drop-down. -2. Select **Users**. -3. Use the **checkboxes** next to **Usernames** to bulk select users. -4. Select **Resend invites**. -5. Select **Resend** to confirm. - -## Invite members via API - -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) API endpoint. - -## Manage members on a team - -Teams exist at the organization level, not the company level. After inviting members to an organization, you can add them to teams within that organization using Docker Hub. For more details, see [Manage members](../../organization/manage/members.md#manage-members-on-a-team). diff --git a/content/manuals/admin/company/new-company.md b/content/manuals/admin/company/new-company.md index f23e8e523019..38cd05e04842 100644 --- a/content/manuals/admin/company/new-company.md +++ b/content/manuals/admin/company/new-company.md @@ -1,16 +1,16 @@ --- title: Create new company -linkTitle: Create +linkTitle: Setup weight: 10 description: Learn how to create a company to centrally manage multiple organizations. -keywords: company, hub, organization, company owner, Admin Console, company management, Docker Business, create company, Docker Admin Console +keywords: company, hub, organization, company owner, Docker Home, company management, Docker Business, create company aliases: - /docker-hub/new-company/ --- {{< summary-bar feature_name="Company" >}} -Learn how to create a new company in the Docker Admin Console, a centralized +Learn how to create a new company in Docker Home, a centralized dashboard for managing organizations. ## Prerequisites @@ -41,13 +41,13 @@ When you create the company, the organization you selected is automatically migrated to the new company. For more information on how you can add more organizations to your company, -see [Add organizations to a company](./manage/organizations.md#add-organizations-to-a-company). +see [Add more organizations](./manage.md#add-more-organizations). ## Next steps -- [Manage organizations](./manage/organizations.md) -- [Manage company members](./manage/users.md) -- [Manage company owners](./manage/owners.md) +- [Add organizations](./manage.md#add-more-organizations) +- [Invite company members](./manage.md#company-invitations) +- [Manage company owners](./manage.md#company-owners) ## More resources diff --git a/content/manuals/admin/organization/_index.md b/content/manuals/admin/organization/_index.md index 2d4ece38e93d..8adf3e3f60a3 100644 --- a/content/manuals/admin/organization/_index.md +++ b/content/manuals/admin/organization/_index.md @@ -3,45 +3,26 @@ title: Organization overview linkTitle: Organization weight: 10 description: Learn how to manage your Docker organization, including teams, members, permissions, and settings. -keywords: organizations, admin, overview, manage teams, roles +keywords: organizations, admin, overview, manage teams, roles, members, permissions, organization settings grid: - title: Onboard your organization description: Learn how to onboard and secure your organization. icon: magnifying-glass-plus link: /admin/organization/setup/onboard - title: Manage members - description: Explore how to manage members. + description: Learn how to manage members. icon: user-plus link: /admin/organization/manage/members/ - title: Activity logs description: Learn how to audit the activities of your members. icon: document-text link: /admin/activity-logs/ - - title: Image Access Management - description: Control which types of images your developers can pull. - icon: photo - link: /admin/organization/image-access/ - - title: Registry Access Management - description: Define which registries your developers can access. - icon: server - link: /admin/organization/registry-access/ - - title: Organization settings - description: Configure information for your organization and manage settings. - icon: cog-6-tooth - link: /admin/organization/setup/general-settings/ - - title: SSO and SCIM + - title: Security description: - "Set up [Single Sign-On](/manuals/enterprise/security/single-sign-on/_index.md) - and [SCIM](/manuals/enterprise/security/provisioning/scim/_index.md) for your organization." - icon: key - - title: Domain management - description: Add, verify, and audit your domains. - link: /enterprise/security/domain-management/ - icon: check-badge - - title: FAQs - description: Explore common organization FAQs. - link: /faq/admin/organization-faqs/ - icon: question-mark-circle + Start here to manage security and access for your organization, including + single sign-on, provisioning, and image and registry access management. + icon: shield-check + link: /enterprise/security/ --- A Docker organization is a collection of teams and repositories with centralized @@ -54,15 +35,20 @@ The following diagram shows how organizations relate to teams and members. ![Diagram showing how teams and members relate within a Docker organization](/admin/images/org-structure.webp) -## Organization members +For how organizations fit into the broader company hierarchy, see the +[administration overview](/manuals/admin/_index.md#company-and-organization-hierarchy). -Organization owners have full administrator access to manage members, roles, -and teams across the organization. +## Organization roles -An organization includes members and optional teams. Teams help group members -and simplify permission management. +An organization includes owners, members, and optional teams. Organization +owners have full administrator access to manage members, roles, and teams. A +team is an optional grouping of members that share the same repository +permissions. -## Create and manage your organization +For details about each role and its permissions, see +[Roles and permissions](/manuals/enterprise/security/roles-and-permissions/_index.md). + +## What's next Learn how to create and manage your organization in the following sections. diff --git a/content/manuals/admin/organization/manage/members.md b/content/manuals/admin/organization/manage/members.md index 919b858a58f3..94d236ca50c4 100644 --- a/content/manuals/admin/organization/manage/members.md +++ b/content/manuals/admin/organization/manage/members.md @@ -9,32 +9,46 @@ aliases: - /admin/organization/members/ --- -Learn how to manage members for your organization in Docker Hub and the Docker Admin Console. +Learn how to manage members for your organization in Docker Hub and the +Docker Admin Console. ## 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 does not have a Docker account, they must create an account 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 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. ### Invite members via Docker ID or email address -Use the following steps to invite members to your organization via Docker ID or email address. +Use the following steps to invite members to your organization via Docker ID +or email address. -1. Sign in to [Docker Home](https://app.docker.com) and select your organization from the top-left account drop-down. +1. Sign in to [Docker Home](https://app.docker.com) and select your + organization from the top-left account drop-down. 1. Select **Members**, then **Invite**. 1. Select **Emails or usernames**. -1. Follow the on-screen instructions to invite members. Invite a maximum of 1000 members and separate multiple entries by comma, semicolon, or space. +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. +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. +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: +To invite multiple members to an organization via a CSV file containing email +addresses: -1. Sign in to [Docker Home](https://app.docker.com) and select your organization from the top-left account drop-down. Select **Members** > **Invite** > **CSV upload**. -1. Optional. Select **Download the template CSV file** to download an example CSV file. The following is an example of the contents of a valid CSV file: +1. Sign in to [Docker Home](https://app.docker.com) and select your + organization from the top-left account drop-down. Select **Members** > + **Invite** > **CSV upload**. +1. Optional. Select **Download the template CSV file** to download an example + CSV file. The following is an example of the contents of a valid CSV file: ```text email @@ -43,55 +57,82 @@ To invite multiple members to an organization via a CSV file containing email ad ``` 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. - - 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. + - 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. 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 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 export a CSV file from another application, see the 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. 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. +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 -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) API endpoint. +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) +API endpoint. ## Accept invitation -After receiving an email invitation, users can access -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. To accept an invitation: 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 **click here** link. -1. 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. -1. 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. -1. Once you are signed in to Docker Hub, select **My Hub** from the top-level navigation menu. +1. To open the link to Docker Hub, select the link in the invitation email. +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 + navigation menu. 1. Select **Accept** on your invitation. After accepting an invitation, you are now 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 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. ## 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 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. > [!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 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. ### Resend an invitation -You can send individual invitations, or bulk invitations from the Admin Console. +You can send individual invitations, or bulk invitations from the Admin +Console. To resend an individual invitation: @@ -117,12 +158,15 @@ 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 **action menu** next to the invitee and select + **Remove invitee**. 1. Select **Remove** to confirm. ## Manage members on 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. +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 @@ -132,27 +176,38 @@ To add a member to a team: 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**. You can add the member by searching for their email + address or username. -An invitee must first accept the invitation to join the organization before being added to the team. +An invitee must first accept the invitation to join the organization before +being added to the 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. +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. -Organization owners can remove a member from a team. Removing the member from the team will revoke their access to the permitted resources. To remove a member from a specific team: +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: 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 choose the name of the team member you want to + remove. 1. Select the **X** next to the user's name to remove them from the team. 1. When prompted, select **Remove** to confirm. ### Update a member role -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). +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: @@ -162,20 +217,23 @@ To update a member role: 1. Find the username of the member whose role you want to edit. Select the **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. +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. ## Export members CSV file {{< summary-bar feature_name="Admin orgs" >}} -Owners can export a CSV file containing all members. The CSV file for a company contains the following fields: +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 +- 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: