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-03-05 12:09:07 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2021-03-05 12:09:07 +0300
commit77831d580c99993c0367bbb8f2aec373ff09a79a (patch)
tree58712f4fe9b5b5c6543e32a0e98b092e15481930 /doc/api/invitations.md
parent5092e9b37cf208ec604470afd4ebb62b1b58673e (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/invitations.md')
-rw-r--r--doc/api/invitations.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/api/invitations.md b/doc/api/invitations.md
index e9b09ba9708..905e4c2e288 100644
--- a/doc/api/invitations.md
+++ b/doc/api/invitations.md
@@ -107,6 +107,36 @@ Example response:
]
```
+## Update an invitation to a group or project
+
+Updates a pending invitation's access level or access expiry date.
+
+```plaintext
+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](README.md#namespaced-path-encoding) 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`, developer access level). |
+| `expires_at` | string | no | A date string in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`). |
+
+```shell
+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"
+```
+
+Example response:
+
+```json
+{
+ "expires_at": "2012-10-22T14:13:35Z",
+ "access_level": 40,
+}
+```
+
## Delete an invitation to a group or project
Deletes a pending invitation by email address.