Skip to content

G
gitlab-ce
Commit 80007999 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis
Browse files
Options

Merge branch 'docs-users-api-missing-param' into 'master' 

Put back parameter lost during single codebase merge

See merge request gitlab-org/gitlab!25871
parents a577d7be 4dc4fe5c
Show whitespace changes
Inline Side-by-side
Showing with 63 additions and 60 deletions
doc/api/users.md
View file @ 80007999
...@@ -160,7 +160,7 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) ...@@ -160,7 +160,7 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
... ...
"shared_runners_minutes_limit": 133, "shared_runners_minutes_limit": 133,
"extra_shared_runners_minutes_limit": 133, "extra_shared_runners_minutes_limit": 133,
"note": "DMCA Request: 2018-11-05 | DMCA Violation | Abuse | https://gitlab.zendesk.com/agent/tickets/123" "note": "DMCA Request: 2018-11-05 | DMCA Violation | Abuse | https://gitlab.zendesk.com/agent/tickets/123",
... ...
} }
] ]
...@@ -313,7 +313,7 @@ the `shared_runners_minutes_limit`, `extra_shared_runners_minutes_limit`, and `n ...@@ -313,7 +313,7 @@ the `shared_runners_minutes_limit`, `extra_shared_runners_minutes_limit`, and `n
"username": "john_smith", "username": "john_smith",
"shared_runners_minutes_limit": 133, "shared_runners_minutes_limit": 133,
"extra_shared_runners_minutes_limit": 133, "extra_shared_runners_minutes_limit": 133,
"note": "DMCA Request: 2018-11-05 | DMCA Violation | Abuse | https://gitlab.zendesk.com/agent/tickets/123" "note": "DMCA Request: 2018-11-05 | DMCA Violation | Abuse | https://gitlab.zendesk.com/agent/tickets/123",
... ...
} }
``` ```
...@@ -327,7 +327,7 @@ see the `group_saml` option: ...@@ -327,7 +327,7 @@ see the `group_saml` option:
"username": "john_smith", "username": "john_smith",
"shared_runners_minutes_limit": 133, "shared_runners_minutes_limit": 133,
"extra_shared_runners_minutes_limit": 133, "extra_shared_runners_minutes_limit": 133,
"note": "DMCA Request: 2018-11-05 | DMCA Violation | Abuse | https://gitlab.zendesk.com/agent/tickets/123" "note": "DMCA Request: 2018-11-05 | DMCA Violation | Abuse | https://gitlab.zendesk.com/agent/tickets/123",
"identities": [ "identities": [
{"provider": "github", "extern_uid": "2435223452345"}, {"provider": "github", "extern_uid": "2435223452345"},
{"provider": "bitbucket", "extern_uid": "john.smith"}, {"provider": "bitbucket", "extern_uid": "john.smith"},
...@@ -364,33 +364,36 @@ POST /users ...@@ -364,33 +364,36 @@ POST /users
Parameters: Parameters:
- `email` (required) - Email | Attribute | Required | Description |
- `password` (optional) - Password |:-------------------------------------|:---------|:--------------------------------------------------------------------------------------------------------------------------------------------------------|
- `reset_password` (optional) - Send user password reset link - true or false(default) | `admin` | No | User is admin - true or false (default) |
- `force_random_password` (optional) - Set user password to a random value - true or false (default) | `avatar` | No | Image file for user's avatar |
- `username` (required) - Username | `bio` | No | User's biography |
- `name` (required) - Name | `can_create_group` | No | User can create groups - true or false |
- `skype` (optional) - Skype ID | `color_scheme_id` | No | User's color scheme for the file viewer (see [the user preference docs](../user/profile/preferences.md#syntax-highlighting-theme) for more information) |
- `linkedin` (optional) - LinkedIn | `email` | Yes | Email |
- `twitter` (optional) - Twitter account | `extern_uid` | No | External UID |
- `website_url` (optional) - Website URL | `external` | No | Flags the user as external - true or false (default) |
- `organization` (optional) - Organization name | `extra_shared_runners_minutes_limit` | No | Extra pipeline minutes quota for this user **(STARTER)** |
- `projects_limit` (optional) - Number of projects user can create | `force_random_password` | No | Set user password to a random value - true or false (default) |
- `extern_uid` (optional) - External UID | `group_id_for_saml` | No | ID of group where SAML has been configured |
- `provider` (optional) - External provider name | `linkedin` | No | LinkedIn |
- `bio` (optional) - User's biography | `location` | No | User's location |
- `location` (optional) - User's location | `name` | No | Name |
- `public_email` (optional) - The public email of the user | `organization` | No | Organization name |
- `admin` (optional) - User is admin - true or false (default) | `password` | No | Password |
- `can_create_group` (optional) - User can create groups - true or false | `private_profile` | No | User's profile is private - true, false (default), or null (will be converted to false) |
- `skip_confirmation` (optional) - Skip confirmation - true or false (default) | `projects_limit` | No | Number of projects user can create |
- `external` (optional) - Flags the user as external - true or false (default) | `provider` | No | External provider name |
- `avatar` (optional) - Image file for user's avatar | `public_email` | No | The public email of the user |
- `theme_id` (optional) - The GitLab theme for the user (see [the user preference docs](../user/profile/preferences.md#navigation-theme) for more information) | `reset_password` | No | Send user password reset link - true or false(default) |
- `color_scheme_id` (optional) - User's color scheme for the file viewer (see [the user preference docs](../user/profile/preferences.md#syntax-highlighting-theme) for more information) | `shared_runners_minutes_limit` | No | Pipeline minutes quota for this user **(STARTER)** |
- `private_profile` (optional) - User's profile is private - true, false (default), or null (will be converted to false) | `skip_confirmation` | No | Skip confirmation - true or false (default) |
- `shared_runners_minutes_limit` (optional) - Pipeline minutes quota for this user **(STARTER)** | `skype` | No | Skype ID |
- `extra_shared_runners_minutes_limit` (optional) - Extra pipeline minutes quota for this user **(STARTER)** | `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 |
| `website_url` | No | Website URL |
## User modification ## User modification
...@@ -402,36 +405,36 @@ PUT /users/:id ...@@ -402,36 +405,36 @@ PUT /users/:id
Parameters: Parameters:
- `id` (required) - The ID of the user | Attribute | Required | Description |
- `email` (optional) - Email |:-------------------------------------|:---------|:--------------------------------------------------------------------------------------------------------------------------------------------------------|
- `username` (optional) - Username | `admin` | No | User is admin - true or false (default) |
- `name` (optional) - Name | `avatar` | No | Image file for user's avatar |
- `password` (optional) - Password | `bio` | No | User's biography |
- `skype` (optional) - Skype ID | `can_create_group` | No | User can create groups - true or false |
- `linkedin` (optional) - LinkedIn | `color_scheme_id` | No | User's color scheme for the file viewer (see [the user preference docs](../user/profile/preferences.md#syntax-highlighting-theme) for more information) |
- `twitter` (optional) - Twitter account | `email` | No | Email |
- `website_url` (optional) - Website URL | `extern_uid` | No | External UID |
- `organization` (optional) - Organization name | `external` | No | Flags the user as external - true or false (default) |
- `projects_limit` (optional) - Limit projects each user can create | `extra_shared_runners_minutes_limit` | No | Extra pipeline minutes quota for this user **(STARTER)** |
- `extern_uid` (optional) - External UID | `group_id_for_saml` | No | ID of group where SAML has been configured |
- `provider` (optional) - External provider name | `id` | Yes | The ID of the user |
- `group_id_for_saml` (optional) - ID of group where SAML has been configured | `linkedin` | No | LinkedIn |
- `bio` (optional) - User's biography | `location` | No | User's location |
- `location` (optional) - User's location | `name` | No | Name |
- `public_email` (optional) - The public email of the user | `note` | No | Admin notes for this user **(STARTER)** |
- `admin` (optional) - User is admin - true or false (default) | `organization` | No | Organization name |
- `can_create_group` (optional) - User can create groups - true or false | `password` | No | Password |
- `skip_reconfirmation` (optional) - Skip reconfirmation - true or false (default) | `private_profile` | No | User's profile is private - true, false (default), or null (will be converted to false) |
- `external` (optional) - Flags the user as external - true or false (default) | `projects_limit` | No | Limit projects each user can create |
- `shared_runners_minutes_limit` (optional) - Pipeline minutes quota for this user | `provider` | No | External provider name |
- `extra_shared_runners_minutes_limit` (optional) - Extra pipeline minutes quota for this user | `public_email` | No | The public email of the user |
- `avatar` (optional) - Image file for user's avatar | `shared_runners_minutes_limit` | No | Pipeline minutes quota for this user **(STARTER)** |
- `theme_id` (optional) - The GitLab theme for the user (see [the user preference docs](../user/profile/preferences.md#navigation-theme) for more information) | `skip_reconfirmation` | No | Skip reconfirmation - true or false (default) |
- `color_scheme_id` (optional) - User's color scheme for the file viewer (see [the user preference docs](../user/profile/preferences.md#syntax-highlighting-theme) for more information) | `skype` | No | Skype ID |
- `private_profile` (optional) - User's profile is private - true, false (default), or null (will be converted to false) | `theme_id` | No | The GitLab theme for the user (see [the user preference docs](../user/profile/preferences.md#navigation-theme) for more information) |
- `shared_runners_minutes_limit` (optional) - Pipeline minutes quota for this user **(STARTER)** | `twitter` | No | Twitter account |
- `extra_shared_runners_minutes_limit` (optional) - Extra pipeline minutes quota for this user **(STARTER)** | `username` | No | Username |
- `note` (optional) - Admin notes for this user **(STARTER)** | `website_url` | No | Website URL |
On password update, user will be forced to change it upon next login. On password update, user will be forced to change it upon next login.
Note, at the moment this method does only return a `404` error, Note, at the moment this method does only return a `404` error,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7