Commit 55c4ad05 authored by Takuya Noguchi's avatar Takuya Noguchi

Update documentation of User modification API params

Signed-off-by: default avatarTakuya Noguchi <takninnovationresearch@gmail.com>
parent 187eed0b
...@@ -393,20 +393,21 @@ PUT /users/:id ...@@ -393,20 +393,21 @@ PUT /users/:id
Parameters: Parameters:
- `email` - Email - `id` (required) - The ID of the user
- `username` - Username - `email` (optional) - Email
- `name` - Name - `username` (optional) - Username
- `password` - Password - `name` (optional) - Name
- `skype` - Skype ID - `password` (optional) - Password
- `linkedin` - LinkedIn - `skype` (optional) - Skype ID
- `twitter` - Twitter account - `linkedin` (optional) - LinkedIn
- `website_url` - Website URL - `twitter` (optional) - Twitter account
- `organization` - Organization name - `website_url` (optional) - Website URL
- `projects_limit` - Limit projects each user can create - `organization` (optional) - Organization name
- `extern_uid` - External UID - `projects_limit` (optional) - Limit projects each user can create
- `provider` - External provider name - `extern_uid` (optional) - External UID
- `provider` (optional) - External provider name
- `group_id_for_saml` (optional) - ID of group where SAML has been configured - `group_id_for_saml` (optional) - ID of group where SAML has been configured
- `bio` - User's biography - `bio` (optional) - User's biography
- `location` (optional) - User's location - `location` (optional) - User's location
- `public_email` (optional) - The public email of the user - `public_email` (optional) - The public email of the user
- `admin` (optional) - User is admin - true or false (default) - `admin` (optional) - User is admin - true or false (default)
...@@ -419,7 +420,7 @@ Parameters: ...@@ -419,7 +420,7 @@ Parameters:
- `private_profile` (optional) - User's profile is private - true or false (default) - `private_profile` (optional) - User's profile is private - true or false (default)
- `shared_runners_minutes_limit` (optional) - Pipeline minutes quota for this user **(STARTER)** - `shared_runners_minutes_limit` (optional) - Pipeline minutes quota for this user **(STARTER)**
- `extra_shared_runners_minutes_limit` (optional) - Extra pipeline minutes quota for this user **(STARTER)** - `extra_shared_runners_minutes_limit` (optional) - Extra pipeline minutes quota for this user **(STARTER)**
- `note` (optional) - Admin notes for this user **(STARTER)** - `note` (optional) - Admin notes for this user **(STARTER)**
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