diff options
Diffstat (limited to 'doc/api/groups.md')
| -rw-r--r-- | doc/api/groups.md | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md index 6b17af63853..c9ec64e83db 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -59,6 +59,7 @@ GET /groups "auto_devops_enabled": null, "subgroup_creation_level": "owner", "emails_disabled": null, + "emails_enabled": null, "mentions_disabled": null, "lfs_enabled": true, "default_branch_protection": 2, @@ -97,6 +98,7 @@ GET /groups?statistics=true "auto_devops_enabled": null, "subgroup_creation_level": "owner", "emails_disabled": null, + "emails_enabled": null, "mentions_disabled": null, "lfs_enabled": true, "default_branch_protection": 2, @@ -181,6 +183,7 @@ GET /groups/:id/subgroups "auto_devops_enabled": null, "subgroup_creation_level": "owner", "emails_disabled": null, + "emails_enabled": null, "mentions_disabled": null, "lfs_enabled": true, "default_branch_protection": 2, @@ -242,6 +245,7 @@ GET /groups/:id/descendant_groups "auto_devops_enabled": null, "subgroup_creation_level": "owner", "emails_disabled": null, + "emails_enabled": null, "mentions_disabled": null, "lfs_enabled": true, "default_branch_protection": 2, @@ -267,6 +271,7 @@ GET /groups/:id/descendant_groups "auto_devops_enabled": null, "subgroup_creation_level": "owner", "emails_disabled": null, + "emails_enabled": null, "mentions_disabled": null, "lfs_enabled": true, "default_branch_protection": 2, @@ -467,6 +472,7 @@ Example response: "pages_access_level":"enabled", "security_and_compliance_access_level":"enabled", "emails_disabled":null, + "emails_enabled": null, "shared_runners_enabled":true, "lfs_enabled":true, "creator_id":1, @@ -818,7 +824,8 @@ Parameters: | `avatar` | mixed | no | Image file for avatar of the group. [Introduced in GitLab 12.9](https://gitlab.com/gitlab-org/gitlab/-/issues/36681) | | `default_branch_protection` | integer | no | See [Options for `default_branch_protection`](#options-for-default_branch_protection). Default to the global level default branch protection setting. | | `description` | string | no | The group's description. | -| `emails_disabled` | boolean | no | Disable email notifications. | +| `emails_disabled` | boolean | no | _([Deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/127899) in GitLab 16.5.)_ Disable email notifications. Use `emails_enabled` instead. | +| `emails_enabled` | boolean | no | Enable email notifications. | | `lfs_enabled` | boolean | no | Enable/disable Large File Storage (LFS) for the projects in this group. | | `mentions_disabled` | boolean | no | Disable the capability of a group from getting mentioned. | | `parent_id` | integer | no | The parent group ID for creating nested group. | @@ -975,7 +982,8 @@ PUT /groups/:id | `avatar` | mixed | no | Image file for avatar of the group. [Introduced in GitLab 12.9](https://gitlab.com/gitlab-org/gitlab/-/issues/36681) | | `default_branch_protection` | integer | no | See [Options for `default_branch_protection`](#options-for-default_branch_protection). | | `description` | string | no | The description of the group. | -| `emails_disabled` | boolean | no | Disable email notifications. | +| `emails_disabled` | boolean | no | _([Deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/127899) in GitLab 16.5.)_ Disable email notifications. Use `emails_enabled` instead. | +| `emails_enabled` | boolean | no | Enable email notifications. | | `lfs_enabled` | boolean | no | Enable/disable Large File Storage (LFS) for the projects in this group. | | `mentions_disabled` | boolean | no | Disable the capability of a group from getting mentioned. | | `prevent_sharing_groups_outside_hierarchy` | boolean | no | See [Prevent group sharing outside the group hierarchy](../user/group/access_and_permissions.md#prevent-group-sharing-outside-the-group-hierarchy). This attribute is only available on top-level groups. [Introduced in GitLab 14.1](https://gitlab.com/gitlab-org/gitlab/-/issues/333721) | @@ -1332,6 +1340,10 @@ Example response: } ``` +| Attribute | Type | Required | Description | +| --------- | --------------- | -------- | ----------- | +| `expires_at` | date | no | Personal access token expiry date. When left blank, the token follows the [standard rule of expiry for personal access tokens](../user/profile/personal_access_tokens.md#when-personal-access-tokens-expire). | + ### Rotate a Personal Access Token for Service Account User > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/406781) in GitLab 16.1. @@ -1476,6 +1488,7 @@ PUT /groups/:id/hooks/:hook_id | `releases_events` | boolean | no | Trigger hook on release events. | | `subgroup_events` | boolean | no | Trigger hook on subgroup events. | | `enable_ssl_verification` | boolean | no | Do SSL verification when triggering the hook. | +| `service_access_tokens_expiration_enforced` | boolean | no | Require service account access tokens to have an expiration date. | | `token` | string | no | Secret token to validate received payloads. Not returned in the response. When you change the webhook URL, the secret token is reset and not retained. | ### Delete group hook |