Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2021-01-19 15:10:46 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2021-01-19 15:10:46 +0300
commit442a79b7336b763ad390285ef75f4e4ff48a9cd0 (patch)
tree75ad88357d71e33c1fc92618cd618cfaa2bfeb69 /doc/api/invitations.md
parentfcef382cb994b8ecdbff75490bab0425a35f2641 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/invitations.md')
-rw-r--r--doc/api/invitations.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/api/invitations.md b/doc/api/invitations.md
index 0891a343cce..7259dddec8c 100644
--- a/doc/api/invitations.md
+++ b/doc/api/invitations.md
@@ -106,3 +106,27 @@ Example response:
},
]
```
+
+## Delete an invitation to a group or project
+
+Deletes a pending invitation by email address.
+
+```plaintext
+DELETE /groups/:id/invitations/:email
+DELETE /projects/:id/invitations/:email
+```
+
+| Attribute | Type | Required | Description |
+| --------- | ---- | -------- | ----------- |
+| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](README.md#namespaced-path-encoding) owned by the authenticated user |
+| `email` | string | yes | The email address to which the invitation was previously sent |
+
+```shell
+curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/55/invitations/email@example.org"
+curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/55/invitations/email@example.org"
+```
+
+- Returns `204` and no content on success.
+- Returns `403` forbidden if unauthorized to delete the invitation.
+- Returns `404` not found if authorized and no invitation is found for that email address.
+- Returns `409` if the request was valid but the invitation could not be deleted.