Skip to content
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

Documentation: invite user outside of the organization #7074

Merged
merged 5 commits into from
Nov 7, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 49 additions & 15 deletions site/content/en/docs/manual/advanced/organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@ See:
- [Create new organization](#create-new-organization)
- [Switching between organizations](#switching-between-organizations)
- [Organization page](#organization-page)
- [Invite members into organization](#invite-members-into-organization)
- [Delete organization](#delete-organization)
- [Invite members into organization](#invite-members-into-organization)
- [Inviting members with existing CVAT accounts](#inviting-members-with-existing-cvat-accounts)
- [Inviting members without CVAT accounts](#inviting-members-without-cvat-accounts)
- [Delete organization](#delete-organization)

## Personal workspace

Expand Down Expand Up @@ -109,32 +111,25 @@ To go to the **Organization page**, do the following:

![](/images/image235.jpg)

### Invite members into organization
## Invite members into organization

To add members to **Organization** do the following:
Invite members form is available from [Organization page](#organization-page).

1. Go to the [**Organization page**](#organization-page), and click **Invite members**.
2. Fill in the form (see below).

![](/images/image236.jpg)

3. Click **Ok**.

The **Invite Members** form has the following fields:
It has the following fields:

![](/images/invitemembers.jpg)

<!--lint disable maximum-line-length-->

| Field | Description |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Email** | Specifies the email address of the user who is being added to the **Organization**. <br><br>**Note**, that the user you're inviting must already have a CVAT account (on the same instance) registered to the email address you're sending the invitation to. |
| **Email** | Specifies the email address of the user who is being added to the **Organization**. |
| Role drop-down list | Defines the role of the user which sets the level of access within the **Organization**: <br><li>**Worker**: Has access only to the tasks, projects, and jobs assigned to them. <li>**Supervisor**: Can create and assign jobs, tasks, and projects to the **Organization** members. <li>**Maintainer**: Has the same capabilities as the **Supervisor**, but with additional visibility over all tasks and projects created by other members, complete access to **Cloud Storages**, and the ability to modify members and their roles. <li>**Owner**: role assigned to the creator of the organization by default. Has maximum capabilities and cannot be changed or assigned to the other user. |
| **Invite more** | Button to add another user to the **Organization**. |

<!--lint enable maximum-line-length-->

Members of **Organization** will appear on the **Organization page**.
Members of **Organization** will appear on the **Organization page**:

![](/images/image237.jpg)

Expand All @@ -144,7 +139,46 @@ by going to **Organization page** > **Leave organization**.
The organization owner can remove members, by
clicking on the **Bin** icon.

### Delete organization
### Inviting members with existing CVAT accounts

To invite members to **Organization** do the following:

1. Go to the [**Organization page**](#organization-page), and click **Invite members**.
2. Fill in the form (see below).

![](/images/image236.jpg)

3. Click **Ok**.

### Inviting members without CVAT accounts

To invite members to **Organization** do the following:

1. Go to the [**Organization page**](#organization-page), and click **Invite members**.
2. Fill in the form (see below).

![](/images/image236.jpg)

3. Click **Ok**.
4. The person being invited will receive an email with the link.

![](/images/invitation_to_org.jpg)

5. Person must click the link and
[**set up an account**](/docs/manual/basics/registration/#user-registration).

6. After account is created, the user will be visible
on the [**Organization page**](#organization-page)
mdacoca marked this conversation as resolved.
Show resolved Hide resolved


The invited user, after setting up the account will
need to confirm email address:

1. Log into CVAT. User will see the **Confirm email** notification.
2. Go to the mailbox, open the message from CVAT and click **Confirm**.
3. Log in to CVAT account again.

## Delete organization

You can remove an organization that you created.

Expand Down
Binary file added site/content/en/images/invitation_to_org.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading