You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/AuthenticationApi.md
+14Lines changed: 14 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,7 @@ Checks if a user by a given `username`, `displayName` or `email` exist. This is
23
23
### Example
24
24
25
25
* Api Key Authentication (apiKeyCookie):
26
+
26
27
```python
27
28
import time
28
29
import vrchatapi
@@ -91,6 +92,7 @@ Name | Type | Description | Notes
91
92
92
93
93
94
### HTTP response details
95
+
94
96
| Status code | Description | Response headers |
95
97
|-------------|-------------|------------------|
96
98
**200** | Returns a response if a user exists or not. | - |
@@ -109,6 +111,7 @@ Deletes the account with given ID. Normal users only have permission to delete t
109
111
110
112
* Api Key Authentication (apiKeyCookie):
111
113
* Api Key Authentication (authCookie):
114
+
112
115
```python
113
116
import time
114
117
import vrchatapi
@@ -176,6 +179,7 @@ Name | Type | Description | Notes
176
179
177
180
178
181
### HTTP response details
182
+
179
183
| Status code | Description | Response headers |
180
184
|-------------|-------------|------------------|
181
185
**200** | OK | - |
@@ -195,6 +199,7 @@ This endpoint does the following two operations: 1) Checks if you are already
195
199
* Api Key Authentication (authCookie):
196
200
* Basic Authentication (authHeader):
197
201
* Api Key Authentication (twoFactorAuthCookie):
202
+
198
203
```python
199
204
import time
200
205
import vrchatapi
@@ -264,6 +269,7 @@ This endpoint does not need any parameter.
264
269
265
270
266
271
### HTTP response details
272
+
267
273
| Status code | Description | Response headers |
268
274
|-------------|-------------|------------------|
269
275
**200** | OK | * Set-Cookie - Successful authentication returns an `auth` cookie. <br> * \0Set-Cookie - This endpoint **always** sets the `apiKey` irrespective if it is already set. <br> |
@@ -281,6 +287,7 @@ Invalidates the login session.
281
287
### Example
282
288
283
289
* Api Key Authentication (authCookie):
290
+
284
291
```python
285
292
import time
286
293
import vrchatapi
@@ -338,6 +345,7 @@ This endpoint does not need any parameter.
338
345
339
346
340
347
### HTTP response details
348
+
341
349
| Status code | Description | Response headers |
342
350
|-------------|-------------|------------------|
343
351
**200** | OK | * Set-Cookie - Clears the `auth` cookie. <br> * \0Set-Cookie - Clears the `age` cookie. <br> * \0\0Set-Cookie - Clears the `tos` cookie. <br> |
@@ -355,6 +363,7 @@ Finishes the login sequence with a normal 2FA-generated code for accounts with 2
355
363
### Example
356
364
357
365
* Api Key Authentication (authCookie):
366
+
358
367
```python
359
368
import time
360
369
import vrchatapi
@@ -420,6 +429,7 @@ Name | Type | Description | Notes
420
429
421
430
422
431
### HTTP response details
432
+
423
433
| Status code | Description | Response headers |
424
434
|-------------|-------------|------------------|
425
435
**200** | OK | * Set-Cookie - Provides a `twoFactorAuth` cookie, which can be used to bypasses the 2FA requirement for future logins on the same device. <br> |
@@ -437,6 +447,7 @@ Verify whether the currently provided Auth Token is valid.
437
447
### Example
438
448
439
449
* Api Key Authentication (authCookie):
450
+
440
451
```python
441
452
import time
442
453
import vrchatapi
@@ -494,6 +505,7 @@ This endpoint does not need any parameter.
494
505
495
506
496
507
### HTTP response details
508
+
497
509
| Status code | Description | Response headers |
498
510
|-------------|-------------|------------------|
499
511
**200** | OK | - |
@@ -511,6 +523,7 @@ Finishes the login sequence with an OTP (One Time Password) recovery code for ac
511
523
### Example
512
524
513
525
* Api Key Authentication (authCookie):
526
+
514
527
```python
515
528
import time
516
529
import vrchatapi
@@ -576,6 +589,7 @@ Name | Type | Description | Notes
576
589
577
590
578
591
### HTTP response details
592
+
579
593
| Status code | Description | Response headers |
580
594
|-------------|-------------|------------------|
581
595
**200** | OK | * Set-Cookie - Provides a `twoFactorAuth` cookie, which can be used to bypasses the 2FA requirement for future logins on the same device. <br> |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
9
8
10
9
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
**value** | **str** | Used to identify which API deployment cluster is currently responding. `blue` and `green` are used by Production. `grape`and `cherry` are used during Development. [Blue Green Deployment by Martin Fowler](https://martinfowler.com/bliki/BlueGreenDeployment.html) | must be one of ["blue", "green", "grape", "cherry", ]
9
-
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
10
9
11
10
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
**value** | **str** | \"none\" User is a normal user \"trusted\" Unknown \"internal\" Is a VRChat Developer \"moderator\" Is a VRChat Moderator Staff can hide their developerType at will. | defaults to "none", must be one of ["none", "trusted", "internal", "moderator", ]
9
-
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
10
9
11
10
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
9
8
10
9
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
**value** | **str** | | defaults to "private", must be one of ["private", "friends", "public", ]
8
-
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
9
8
10
9
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
9
8
10
9
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
**value** | **str** | | must be one of ["world", "friend", "avatar", ]
8
-
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
9
8
10
9
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
0 commit comments