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 2e7b077
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.
22
+
23
+
### Example
24
+
25
+
* Api Key Authentication (apiKeyCookie):
26
+
```python
27
+
import time
28
+
import vrchatapi
29
+
from vrchatapi.api import authentication_api
30
+
from vrchatapi.model.error import Error
31
+
from vrchatapi.model.user_exists import UserExists
32
+
from pprint import pprint
33
+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
34
+
# See configuration.py for a list of all supported configuration parameters.
35
+
configuration = vrchatapi.Configuration(
36
+
host="https://api.vrchat.cloud/api/1"
37
+
)
38
+
39
+
# The client must configure the authentication and authorization parameters
40
+
# in accordance with the API server security policy.
41
+
# Examples for each auth method are provided below, use the example that
**email** | **str**| Filter by email. | [optional]
75
+
**display_name** | **str**| Filter by displayName. | [optional]
76
+
**user_id** | **str**| Filter by UserID. | [optional]
77
+
**exclude_user_id** | **str**| Exclude by UserID. | [optional]
78
+
79
+
### Return type
80
+
81
+
[**UserExists**](UserExists.md)
82
+
83
+
### Authorization
84
+
85
+
[apiKeyCookie](../README.md#apiKeyCookie)
86
+
87
+
### HTTP request headers
88
+
89
+
-**Content-Type**: Not defined
90
+
-**Accept**: application/json
91
+
92
+
93
+
### HTTP response details
94
+
| Status code | Description | Response headers |
95
+
|-------------|-------------|------------------|
96
+
**200** | Returns a response if a user exists or not. | - |
97
+
**400** | Error response when missing at least 1 of the required parameters. | - |
98
+
99
+
[[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)
Status object representing if a queried user by username or userId exists or not. This model is primarily used by the `/auth/exists` endpoint, which in turn is used during registration. Please see the documentation on that endpoint for more information on usage.
**user_exists** | **bool** | Status if a user exist with that username or userId. | defaults to False
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
+
11
+
[[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