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
{{ message }}
Repository navigation
Commit f589586
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/AuthenticationApi.md
+11-25Lines changed: 11 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ import time
28
28
import vrchatapi
29
29
from vrchatapi.api import authentication_api
30
30
from vrchatapi.model.current_user import CurrentUser
31
-
from vrchatapi.model.inline_response401importInlineResponse401
31
+
from vrchatapi.model.errorimportError
32
32
from pprint import pprint
33
33
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
34
34
# See configuration.py for a list of all supported configuration parameters.
@@ -114,7 +114,7 @@ import time
114
114
import vrchatapi
115
115
from vrchatapi.api import authentication_api
116
116
from vrchatapi.model.current_user import CurrentUser
117
-
from vrchatapi.model.inline_response401importInlineResponse401
117
+
from vrchatapi.model.errorimportError
118
118
from pprint import pprint
119
119
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
120
120
# See configuration.py for a list of all supported configuration parameters.
@@ -180,7 +180,7 @@ This endpoint does not need any parameter.
180
180
### HTTP response details
181
181
| Status code | Description | Response headers |
182
182
|-------------|-------------|------------------|
183
-
**200** | OK | * Set-Cookie - Authenticating returns an `auth` cookie. <br> |
183
+
**200** | OK | * Set-Cookie - Authenticating returns an `auth` cookie. <br> * \0Set-Cookie - Authenticating also sets the `apiKey` if not already set. <br> |
184
184
**401** | Error response due to missing apiKey or auth cookie. | - |
185
185
186
186
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
@@ -190,18 +190,17 @@ This endpoint does not need any parameter.
190
190
191
191
Logout
192
192
193
-
Invalidates the auth cookie.
193
+
Invalidates the login session.
194
194
195
195
### Example
196
196
197
-
* Api Key Authentication (apiKeyCookie):
198
197
* Api Key Authentication (authCookie):
199
198
```python
200
199
import time
201
200
import vrchatapi
202
201
from vrchatapi.api import authentication_api
203
202
from vrchatapi.model.success import Success
204
-
from vrchatapi.model.inline_response401importInlineResponse401
203
+
from vrchatapi.model.errorimportError
205
204
from pprint import pprint
206
205
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
207
206
# See configuration.py for a list of all supported configuration parameters.
@@ -261,7 +254,7 @@ This endpoint does not need any parameter.
261
254
### HTTP response details
262
255
| Status code | Description | Response headers |
263
256
|-------------|-------------|------------------|
264
-
**200** | OK | - |
257
+
**200** | OK | * Set-Cookie - Clears the `auth` cookie. <br> * \0Set-Cookie - Clears the `age` cookie. <br> * \0\0Set-Cookie - Clears the `tos` cookie. <br> |
265
258
**401** | Error response due to missing apiKey or auth cookie. | - |
266
259
267
260
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
@@ -281,8 +274,8 @@ import time
281
274
import vrchatapi
282
275
from vrchatapi.api import authentication_api
283
276
from vrchatapi.model.inline_object import InlineObject
277
+
from vrchatapi.model.error import Error
284
278
from vrchatapi.model.inline_response2001 import InlineResponse2001
285
-
from vrchatapi.model.inline_response401 import InlineResponse401
286
279
from pprint import pprint
287
280
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
288
281
# See configuration.py for a list of all supported configuration parameters.
@@ -357,14 +350,13 @@ Verify whether the currently provided Auth Token is valid.
357
350
358
351
### Example
359
352
360
-
* Api Key Authentication (apiKeyCookie):
361
353
* Api Key Authentication (authCookie):
362
354
```python
363
355
import time
364
356
import vrchatapi
365
357
from vrchatapi.api import authentication_api
366
358
from vrchatapi.model.inline_response200 import InlineResponse200
367
-
from vrchatapi.model.inline_response401importInlineResponse401
359
+
from vrchatapi.model.errorimportError
368
360
from pprint import pprint
369
361
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
370
362
# See configuration.py for a list of all supported configuration parameters.
0 commit comments