cloud_controller_ng/docs/v3/source/includes/resources/users/_update.md.erb at 686a8997c86ea5b0941390d975629d247e7b53a5 · peterhaochen47/cloud_controller_ng · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
### Update a user

Update a user's metadata.

```
Example Request
```

```shell
curl "https://api.example.org/v3/users/24d59a1e-2613-4255-86a2-e0454cc6e261" \
  -X PATCH \
  -H "Authorization: bearer [token]" \
  -H "Content-type: application/json" \
  -d '{
    "metadata": {
      "labels": { "environment": "production" },
      "annotations": { "note": "detailed information" }
    }
  }'
```

```
Example Response
```

```http
HTTP/1.1 201 Created
Content-Type: application/json

<%= yield_content :single_user_with_metadata %>
```

#### Definition
`PATCH /v3/users/:guid`

#### Required parameters

Name     | Type     | Description
-------  | -------  | -----------
**metadata.labels**   | [_label object_](#labels) | Labels applied to the app                         |
**metadata.annotations** | [_annotation object_](#annotations) | Annotations added to the user             |

#### Permitted roles

 |
--- | ---
Admin |