Skip to content

Commit 9983d1b

Browse files
fix: shortcode in members/orgs
1 parent 92c4114 commit 9983d1b

File tree

1 file changed

+142
-2
lines changed

1 file changed

+142
-2
lines changed

content/manuals/admin/organization/members.md

Lines changed: 142 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,154 @@ Learn how to manage members for your organization in Docker Hub and the Docker A
1414
{{< tabs >}}
1515
{{< tab name="Admin Console" >}}
1616

17-
{{% admin-users product="admin" %}}
17+
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.
18+
19+
### Invite members via Docker ID or email address
20+
21+
Use the following steps to invite members to your organization via Docker ID or email address.
22+
23+
1. Sign in to [Docker Home](https://app.docker.com) and select your organization.
24+
1. Select **Members**, then **Invite**.
25+
1. Select **Emails or usernames**.
26+
1. Follow the on-screen instructions to invite members. Invite a maximum of 1000 members and separate multiple entries by comma, semicolon, or space.
27+
28+
> [!NOTE]
29+
>
30+
> When you invite members, you assign them a role. See [Roles and permissions](/manuals/security/for-admins/roles-and-permissions.md) for
31+
details about the access permissions for each role.
32+
33+
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.
34+
35+
### Invite members via CSV file
36+
37+
To invite multiple members to an organization via a CSV file containing email addresses:
38+
39+
1. Sign in to [Docker Home](https://app.docker.com) and select your organization.
40+
1. Select **Members**, then **Invite**.
41+
1. Select **CSV upload**.
42+
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.
43+
44+
```text
45+
email
46+
47+
48+
```
49+
50+
CSV file requirements:
51+
52+
- The file must contain a header row with at least one heading named email. Additional columns are allowed and are ignored in the import.
53+
- 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.
54+
55+
1. Create a new CSV file or export a CSV file from another application.
56+
57+
- To export a CSV file from another application, see the application’s documentation.
58+
- 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.
59+
60+
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.
61+
62+
> [!NOTE]
63+
>
64+
> 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](/manuals/subscription/manage-seats.md) to your subscription or [Contact sales](https://www.docker.com/pricing/contact-sales/).
65+
66+
1. After the CSV file has been uploaded, select **Review**.
67+
68+
Valid email addresses and any email addresses that have issues appear. Email addresses may have the following issues:
69+
70+
- 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.
71+
- Already invited: The user has already been sent an invite email and another invite email will not be sent.
72+
- Member: The user is already a member of your organization and an invite email will not be sent.
73+
- Duplicate: The CSV file has multiple occurrences of the same email address. The user will be sent only one invite email.
74+
75+
1. Follow the on-screen instructions to invite members.
76+
77+
> [!NOTE]
78+
>
79+
> When you invite members, you assign them a role. See [Roles and permissions](/manuals/security/for-admins/roles-and-permissions.md) for
80+
details about the access permissions for each role.
81+
82+
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.
83+
84+
### Invite members via API
85+
86+
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.
1887

1988
{{< /tab >}}
2089
{{< tab name="Docker Hub" >}}
2190

2291
{{% include "hub-org-management.md" %}}
2392

24-
{{% admin-users product="hub" %}}
93+
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.
94+
95+
### Invite members via Docker ID or email address
96+
97+
Use the following steps to invite members to your organization via Docker ID or email address.
98+
99+
1. Sign in to [Docker Hub](https://hub.docker.com).
100+
1. Select **My Hub**, your organization, then **Members**.
101+
1. Select **Invite members**.
102+
1. Select **Emails or usernames**.
103+
1. Follow the on-screen instructions to invite members. Invite a maximum of 1000 members and separate multiple entries by comma, semicolon, or space.
104+
105+
> [!NOTE]
106+
>
107+
> When you invite members, you assign them a role. See [Roles and permissions](/manuals/security/for-admins/roles-and-permissions.md) for
108+
details about the access permissions for each role.
109+
110+
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.
111+
112+
### Invite members via CSV file
113+
114+
To invite multiple members to an organization via a CSV file containing email addresses:
115+
116+
1. Sign in to [Docker Hub](https://hub.docker.com).
117+
1. Select **My Hub**, your organization, then **Members**.
118+
1. Select **Invite members**.
119+
1. Select **CSV upload**.
120+
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.
121+
122+
```text
123+
email
124+
125+
126+
```
127+
128+
CSV file requirements:
129+
130+
- The file must contain a header row with at least one heading named email. Additional columns are allowed and are ignored in the import.
131+
- 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.
132+
133+
1. Create a new CSV file or export a CSV file from another application.
134+
135+
- To export a CSV file from another application, see the application’s documentation.
136+
- 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.
137+
138+
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.
139+
140+
> [!NOTE]
141+
>
142+
> 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](/manuals/subscription/manage-seats.md) to your subscription or [Contact sales](https://www.docker.com/pricing/contact-sales/).
143+
144+
1. After the CSV file has been uploaded, select **Review**.
145+
146+
Valid email addresses and any email addresses that have issues appear. Email addresses may have the following issues:
147+
148+
- 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.
149+
- Already invited: The user has already been sent an invite email and another invite email will not be sent.
150+
- Member: The user is already a member of your organization and an invite email will not be sent.
151+
- Duplicate: The CSV file has multiple occurrences of the same email address. The user will be sent only one invite email.
152+
153+
1. Follow the on-screen instructions to invite members.
154+
155+
> [!NOTE]
156+
>
157+
> When you invite members, you assign them a role. See [Roles and permissions](/manuals/security/for-admins/roles-and-permissions.md) for
158+
details about the access permissions for each role.
159+
160+
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.
161+
162+
### Invite members via API
163+
164+
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.
25165

26166
{{< /tab >}}
27167
{{< /tabs >}}

0 commit comments

Comments
 (0)