Update user information

POST

1 from r2r import R2RClient
2 
3 client = R2RClient()
4 # client.login(...)
5 
6 # Update user
7 updated_user = client.update_user(
8     "550e8400-e29b-41d4-a716-446655440000",
9     name="John Doe"
10 )

Play

200Successful

1 {
2   "results": {
3     "id": "id",
4     "email": "email",
5     "is_active": true,
6     "is_superuser": true,
7     "created_at": "2024-01-15T09:30:00Z",
8     "updated_at": "2024-01-15T09:30:00Z",
9     "is_verified": true,
10     "collection_ids": [
11       "collection_ids"
12     ],
13     "graph_ids": [
14       "graph_ids"
15     ],
16     "document_ids": [
17       "document_ids"
18     ],
19     "limits_overrides": {
20       "key": "value"
21     },
22     "metadata": {
23       "key": "value"
24     },
25     "verification_code_expiry": "2024-01-15T09:30:00Z",
26     "name": "name",
27     "bio": "bio",
28     "profile_picture": "profile_picture",
29     "total_size_in_bytes": 1,
30     "num_files": 1,
31     "account_type": "account_type",
32     "hashed_password": "hashed_password",
33     "google_id": "google_id",
34     "github_id": "github_id"
35   }
36 }

Update user information. Users can only update their own information unless they are superusers. Superuser status can only be modified by existing superusers.

Path parameters

idstringRequired

ID of the user to update

Request

This endpoint expects an object.

emailstringOptionalformat: "email"

Updated email address

is_superuserbooleanOptional

Updated superuser status

namestringOptional

Updated user name

biostringOptional

Updated user bio

profile_picturestringOptional

Updated profile picture URL

limits_overridesmap from strings to anyOptional

Updated limits overrides

metadatamap from strings to optional stringsOptional

Response

Successful Response

resultsobject

Update user information

Path parameters

Headers

Request

Response

Errors