diff options
Diffstat (limited to 'doc/api/users.md')
| -rw-r--r-- | doc/api/users.md | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/doc/api/users.md b/doc/api/users.md index 90aafcef035..28d233ce6b3 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -611,7 +611,7 @@ GET /users/:id_or_username/status | Attribute | Type | Required | Description | | ---------------- | ------ | -------- | ----------- | -| `id_or_username` | string | yes | The id or username of the user to get a status of | +| `id_or_username` | string | yes | The ID or username of the user to get a status of | ```shell curl "https://gitlab.example.com/users/janedoe/status" @@ -723,7 +723,7 @@ GET /users/:id_or_username/keys | Attribute | Type | Required | Description | | ---------------- | ------ | -------- | ----------- | -| `id_or_username` | string | yes | The id or username of the user to get the SSH keys for. | +| `id_or_username` | string | yes | The ID or username of the user to get the SSH keys for. | ## Single SSH key @@ -794,7 +794,7 @@ POST /users/:id/keys Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user - `title` (required) - new SSH Key's title - `key` (required) - new SSH key @@ -821,7 +821,7 @@ DELETE /users/:id/keys/:key_id Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user - `key_id` (required) - SSH key ID ## List all GPG keys @@ -1070,7 +1070,7 @@ GET /users/:id/emails Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user ## Single email @@ -1133,7 +1133,7 @@ POST /users/:id/emails Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user - `email` (required) - email address - `skip_confirmation` (optional) - Skip confirmation and assume e-mail is verified - true or false (default) @@ -1160,7 +1160,7 @@ DELETE /users/:id/emails/:email_id Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user - `email_id` (required) - email ID ## Block user @@ -1173,7 +1173,7 @@ POST /users/:id/block Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user Returns: @@ -1191,7 +1191,7 @@ POST /users/:id/unblock Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user Will return `201 OK` on success, `404 User Not Found` is user cannot be found or `403 Forbidden` when trying to unblock a user blocked by LDAP synchronization. @@ -1208,7 +1208,7 @@ POST /users/:id/deactivate Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user Returns: @@ -1230,7 +1230,7 @@ POST /users/:id/activate Parameters: -- `id` (required) - id of specified user +- `id` (required) - ID of specified user Returns: @@ -1409,6 +1409,7 @@ The activities that update the timestamp are: - User logging in into GitLab - User visiting pages related to Dashboards, Projects, Issues, and Merge Requests ([introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/54947) in GitLab 11.8) - User using the API +- User using the GraphQL API By default, it shows the activity for all users in the last 6 months, but this can be amended by using the `from` parameter. |