diff options
Diffstat (limited to 'doc/api/namespaces.md')
| -rw-r--r-- | doc/api/namespaces.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/api/namespaces.md b/doc/api/namespaces.md index ba59d467bc8..0792c6d4a3b 100644 --- a/doc/api/namespaces.md +++ b/doc/api/namespaces.md @@ -87,6 +87,26 @@ the `plan` parameter associated with a namespace: ] ``` +Users on GitLab.com will also see `max_seats_used` and `seats_in_use` parameters. +`max_seats_used` is the highest number of users the group had. `seats_in_use` is +the number of license seats currently being used. Both values are updated +once a day. + +`max_seats_used` and `seats_in_use` will be non-zero only for namespaces on paid plans. + +```json +[ + { + "id": 1, + "name": "user1", + "billable_members_count": 2, + "max_seats_used": 3, + "seats_in_use": 2, + ... + } +] +``` + NOTE: **Note:** Only group maintainers/owners are presented with `members_count_with_descendants`, as well as `plan` **(BRONZE ONLY)**. @@ -123,6 +143,8 @@ Example response: "web_url": "https://gitlab.example.com/groups/twitter", "members_count_with_descendants": 2, "billable_members_count": 2, + "max_seats_used": 0, + "seats_in_use": 0, "plan": "default", "trial_ends_on": null, "trial": false @@ -162,6 +184,8 @@ Example response: "web_url": "https://gitlab.example.com/groups/group1", "members_count_with_descendants": 2, "billable_members_count": 2, + "max_seats_used": 0, + "seats_in_use": 0, "plan": "default", "trial_ends_on": null, "trial": false @@ -188,6 +212,8 @@ Example response: "web_url": "https://gitlab.example.com/groups/group1", "members_count_with_descendants": 2, "billable_members_count": 2, + "max_seats_used": 0, + "seats_in_use": 0, "plan": "default", "trial_ends_on": null, "trial": false |