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-02-24 18:11:10 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2021-02-24 18:11:10 +0300
commit958d8a85d32fece017eac7d99bf28860b01a49d8 (patch)
tree3c84c8447a8d9a6f7ccf7401eeb3cd268570c94f /doc/api/users.md
parent35c5f0c35c83f3c5f8d33fb61713495e29bdec4d (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/users.md')
-rw-r--r--doc/api/users.md29
1 files changed, 22 insertions, 7 deletions
diff --git a/doc/api/users.md b/doc/api/users.md
index 76b0bb3491c..5b966d6ba87 100644
--- a/doc/api/users.md
+++ b/doc/api/users.md
@@ -53,6 +53,9 @@ For example:
GET /users?username=jack_smith
```
+NOTE:
+Username search is case insensitive.
+
In addition, you can filter users based on the states `blocked` and `active`.
It does not support `active=false` or `blocked=false`. The list of billable users
is the total number of users minus the blocked users.
@@ -65,17 +68,33 @@ GET /users?active=true
GET /users?blocked=true
```
+In addition, you can search for external users only with `external=true`.
+It does not support `external=false`.
+
+```plaintext
+GET /users?external=true
+```
+
GitLab supports bot users such as the [alert bot](../operations/incident_management/integrations.md)
or the [support bot](../user/project/service_desk.md#support-bot-user).
-To exclude these users from the users' list, you can use the parameter `exclude_internal=true`
+You can exclude the following types of [internal users](../development/internal_users.md#internal-users)
+from the users' list, with the `exclude_internal=true` parameter,
([introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241144) in GitLab 13.4).
+- Alert bot
+- Support bot
+
+However, this action does not exclude [project bot users](../user/project/settings/project_access_tokens.md#project-bot-users).
+
```plaintext
GET /users?exclude_internal=true
```
-NOTE:
-Username search is case insensitive.
+In addition, to exclude external users from the users' list, you can use the parameter `exclude_external=true`.
+
+```plaintext
+GET /users?exclude_external=true
+```
### For admins
@@ -217,10 +236,6 @@ For example:
GET /users?extern_uid=1234567&provider=github
```
-Instance administrators can search for users who are external with: `/users?external=true`
-
-You cannot search for external users if you are not an instance administrator.
-
You can search users by creation date time range with:
```plaintext