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 82432f7
Browse filesBrowse the repository at this point in the historyBrowse files
Checks if a user by a given `username`, `displayName` or `email` exist. This is used during registration to check if a username has already been taken, during change of displayName to check if a displayName is available, and during change of email to check if the email is already used. In the later two cases the `excludeUserId` is used to exclude oneself, otherwise the result would always be true. It is **REQUIRED** to include **AT LEAST**`username`, `displayName`**or**`email` query parameter. Although they can be combined - in addition with `excludeUserId` (generally to exclude yourself) - to further fine-tune the search.
**email** | **String**| Filter by email. | [optional]
69
+
**displayName** | **String**| Filter by displayName. | [optional]
70
+
**userId** | **String**| Filter by UserID. | [optional]
71
+
**excludeUserId** | **String**| Exclude by UserID. | [optional]
72
+
73
+
### Return type
74
+
75
+
[**UserExists**](UserExists.md)
76
+
77
+
### Authorization
78
+
79
+
[apiKeyCookie](../README.md#apiKeyCookie)
80
+
81
+
### HTTP request headers
82
+
83
+
-**Content-Type**: Not defined
84
+
-**Accept**: application/json
85
+
86
+
### HTTP response details
87
+
| Status code | Description | Response headers |
88
+
|-------------|-------------|------------------|
89
+
**200** | Returns a response if a user exists or not. | - |
90
+
**400** | Error response when missing at least 1 of the required parameters. | - |
91
+
15
92
<aname="deleteUser"></a>
16
93
# **deleteUser**
17
94
> CurrentUser deleteUser(userId)
@@ -94,7 +171,7 @@ Name | Type | Description | Notes
94
171
95
172
Login and/or Get Current User Info
96
173
97
-
Login and/or Get user data from your VRChat account. If `Authorization` header is present then a new login session will be generated, and a new `auth` cookie is returned. **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the `auth` cookie whenever you can, and avoid sending the Authorization header unless strictly neccesary. While the exact number of simultaneous open sessions is secret, expect to **very fast** run into the rate-limit and be temporarily blocked from making new sessions until the old ones expire.
174
+
This endpoint does the following two operations: 1) Checks if you are already logged in by looking for a valid `auth` cookie. If you are have a valid auth cookie then no additional auth-related actions are taken. If you are **not** logged in then it will log you in with the `Authorization` header and set the `auth` cookie. The `auth` cookie will only be sent once. 2) If logged in, this function will also return the CurrentUser object containing detailed information about the currently logged in user. **WARNING: Session Limit:** Each authentication with login credentials counts as a separate session, out of which you have a limited amount. Make sure to save and reuse the `auth` cookie if you are often restarting the program. The provided API libraries automatically save cookies during runtime, but does not persist during restart. While it can be fine to use username/password during development, expect in production to very fast run into the rate-limit and be temporarily blocked from making new sessions until older ones expire. The exact number of simultaneous sessions is unknown/undisclosed.
98
175
99
176
### Example
100
177
```java
@@ -162,7 +239,7 @@ This endpoint does not need any parameter.
162
239
### HTTP response details
163
240
| Status code | Description | Response headers |
164
241
|-------------|-------------|------------------|
165
-
**200** | OK | * Set-Cookie - Authenticating returns an `auth` cookie. <br> * \0Set-Cookie - Authenticating also sets the `apiKey` if not already set. <br> |
242
+
**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> |
166
243
**401** | Error response due to missing apiKey or auth cookie. | - |
0 commit comments