kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss

GitLab Bot e5d3d8c323 Add latest changes from gitlab-org/gitlab@master

2021-10-25 12:10:19 +00:00

7.1 KiB

Raw Blame History

stage	group	info
Growth	Expansion	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments

Invitations API (FREE)

Use the Invitations API to send email to users you want to join a group or project, and to list pending invitations.

Valid access levels

To send an invitation, you must have access to the project or group you are sending email for. Valid access levels are defined in the Gitlab::Access module. Currently, these levels are valid:

No access (0)
Minimal access (5) (Introduced in GitLab 13.5.)
Guest (10)
Reporter (20)
Developer (30)
Maintainer (40)
Owner (50) - Only valid to set for groups

WARNING: Due to an issue, projects in personal namespaces don't show owner (50) permission.

Invite by email to group or project

Invites a new user by email to join a group or project.

POST /groups/:id/invitations
POST /projects/:id/invitations

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project or group owned by the authenticated user
`email`	string	yes	The email of the new member or multiple emails separated by commas
`access_level`	integer	yes	A valid access level
`expires_at`	string	no	A date string in the format YEAR-MONTH-DAY
`invite_source`	string	no	The source of the invitation that starts the member creation process. See this issue.
`areas_of_focus`	string	no	Areas the inviter wants the member to focus upon.
`tasks_to_be_done`	array of strings	no	Tasks the inviter wants the member to focus on. The tasks are added as issues to a specified project. The possible values are: `ci`, `code` and `issues`. If specified, requires `tasks_project_id`. Introduced in GitLab 14.5 with a flag named `invite_members_for_task`. Disabled by default.
`tasks_project_id`	integer	no	The project ID in which to create the task issues. If specified, requires `tasks_to_be_done`. Introduced in GitLab 14.5 with a flag named `invite_members_for_task`. Disabled by default.

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     --data "email=test@example.com&access_level=30" "https://gitlab.example.com/api/v4/groups/:id/invitations"
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     --data "email=test@example.com&access_level=30" "https://gitlab.example.com/api/v4/projects/:id/invitations"

Example responses:

When all emails were successfully sent:

{  "status":  "success"  }

When there was any error sending the email:

{
  "status": "error",
  "message": {
               "test@example.com": "Invite email has already been taken",
               "test2@example.com": "User already exists in source"
             }
}

List all invitations pending for a group or project

Gets a list of invited group or project members viewable by the authenticated user. Returns invitations to direct members only, and not through inherited ancestors' groups.

This function takes pagination parameters page and per_page to restrict the list of users.

GET /groups/:id/invitations
GET /projects/:id/invitations

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project or group owned by the authenticated user
`page`	integer	no	Page to retrieve
`per_page`	integer	no	Number of member invitations to return per page
`query`	string	no	A query string to search for invited members by invite email. Query text must match email address exactly. When empty, returns all invitations.

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/invitations?query=member@example.org"
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/invitations?query=member@example.org"

Example response:

 [
   {
     "id": 1,
     "invite_email": "member@example.org",
     "created_at": "2020-10-22T14:13:35Z",
     "access_level": 30,
     "expires_at": "2020-11-22T14:13:35Z",
     "user_name": "Raymond Smith",
     "created_by_name": "Administrator"
   },
]

Update an invitation to a group or project

Updates a pending invitation's access level or access expiry date.

PUT /groups/:id/invitations/:email
PUT /projects/:id/invitations/:email

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project or group owned by the authenticated user.
`email`	string	yes	The email address to which the invitation was previously sent.
`access_level`	integer	no	A valid access level (defaults: `30`, the Developer role).
`expires_at`	string	no	A date string in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`).

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/55/invitations/email@example.org?access_level=40"
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/55/invitations/email@example.org?access_level=40"