diff options
Diffstat (limited to 'doc/api/users.md')
| -rw-r--r-- | doc/api/users.md | 31 |
1 files changed, 24 insertions, 7 deletions
diff --git a/doc/api/users.md b/doc/api/users.md index 76b0bb3491c..b8917f3e215 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 @@ -433,6 +448,7 @@ Parameters: | `theme_id` | No | The GitLab theme for the user (see [the user preference docs](../user/profile/preferences.md#navigation-theme) for more information) | | `twitter` | No | Twitter account | | `username` | Yes | Username | +| `view_diffs_file_by_file` | No | Flag indicating the user sees only one file diff per page | | `website_url` | No | Website URL | ## User modification @@ -474,6 +490,7 @@ Parameters: | `theme_id` | No | The GitLab theme for the user (see [the user preference docs](../user/profile/preferences.md#navigation-theme) for more information) | | `twitter` | No | Twitter account | | `username` | No | Username | +| `view_diffs_file_by_file` | No | Flag indicating the user sees only one file diff per page | | `website_url` | No | Website URL | On password update, the user is forced to change it upon next login. |