Skip to content

Commit c7837df

Browse files
jellejurrejellejurre
committed
Deploying to gh-pages from @ fa5e220 🚀
1 parent 38a4a84 commit c7837df

2 files changed

Lines changed: 172 additions & 18 deletions

File tree

‎dist/openapi.yaml‎

Lines changed: 86 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,26 @@ paths:
244244
security:
245245
- authCookie: []
246246
parameters: []
247+
/auth/user/twofactorauth/otp:
248+
get:
249+
summary: Get 2FA Recovery codes
250+
operationId: getRecoveryCodes
251+
x-codeSamples:
252+
- lang: cURL
253+
source: |-
254+
curl -X GET "https://api.vrchat.cloud/api/1/auth/user/twofactorauth/otp" \
255+
-H "Content-Type: application/json" \
256+
-b "auth={authCookie}"
257+
responses:
258+
'200':
259+
$ref: '#/components/responses/Get2FARecoveryCodesResponse'
260+
'401':
261+
$ref: '#/components/responses/MissingCredentialsError'
262+
description: Gets the OTP (One Time Password) recovery codes for accounts with 2FA-protection enabled.
263+
tags:
264+
- authentication
265+
security:
266+
- authCookie: []
247267
/auth/twofactorauth/otp/verify:
248268
post:
249269
summary: Verify 2FA code with Recovery code
@@ -2998,7 +3018,7 @@ paths:
29983018
description: |-
29993019
Close an instance or update the closedAt time when it will be closed.
30003020
3001-
You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-moderate` permission.
3021+
You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-manage` permission.
30023022
responses:
30033023
'200':
30043024
$ref: '#/components/responses/InstanceResponse'
@@ -3807,6 +3827,8 @@ paths:
38073827
responses:
38083828
'200':
38093829
$ref: '#/components/responses/CurrentUserResponse'
3830+
'400':
3831+
$ref: '#/components/responses/CurrentPasswordRequiredError'
38103832
'401':
38113833
$ref: '#/components/responses/MissingCredentialsError'
38123834
description: Update a users information such as the email and birthday.
@@ -4592,6 +4614,14 @@ components:
45924614
- badgeImageUrl
45934615
- badgeName
45944616
- showcased
4617+
Tag:
4618+
description: |-
4619+
Tags are a way to grant various access, assign restrictions or other kinds of metadata to various to objects such as worlds, users and avatars.
4620+
4621+
System tags starting with `system_` are granted automatically by the system, while admin tags with `admin_` are granted manually. More prefixes such as `language_ ` (to indicate that a player can speak the tagged language), and `author_tag_` (provided by a world author for search and sorting) exist as well.
4622+
minLength: 1
4623+
title: Tag
4624+
type: string
45954625
AvatarID:
45964626
example: avtr_912d66a4-4714-43b8-8407-7de2cafbf55b
45974627
title: AvatarID
@@ -4606,14 +4636,6 @@ components:
46064636
example: https://api.vrchat.cloud/api/1/image/file_aae83ed9-d42d-4d72-9f4b-9f1e41ed17e1/1/256
46074637
title: CurrentAvatarThumbnailImageUrl
46084638
type: string
4609-
Tag:
4610-
description: |-
4611-
Tags are a way to grant various access, assign restrictions or other kinds of metadata to various to objects such as worlds, users and avatars.
4612-
4613-
System tags starting with `system_` are granted automatically by the system, while admin tags with `admin_` are granted manually. More prefixes such as `language_ ` (to indicate that a player can speak the tagged language), and `author_tag_` (provided by a world author for search and sorting) exist as well.
4614-
minLength: 1
4615-
title: Tag
4616-
type: string
46174639
DeveloperType:
46184640
default: none
46194641
description: |-
@@ -4778,6 +4800,11 @@ components:
47784800
type: array
47794801
items:
47804802
type: string
4803+
contentFilters:
4804+
description: These tags begin with `content_` and control content gating
4805+
type: array
4806+
items:
4807+
$ref: '#/components/schemas/Tag'
47814808
currentAvatar:
47824809
$ref: '#/components/schemas/AvatarID'
47834810
currentAvatarImageUrl:
@@ -5004,6 +5031,26 @@ components:
50045031
type: boolean
50055032
required:
50065033
- verified
5034+
TwoFactorRecoveryCodes:
5035+
title: TwoFactorRecoveryCodes
5036+
type: object
5037+
properties:
5038+
requiresTwoFactorAuth:
5039+
type: array
5040+
items:
5041+
type: string
5042+
otp:
5043+
type: array
5044+
items:
5045+
type: object
5046+
required:
5047+
- code
5048+
- used
5049+
properties:
5050+
code:
5051+
type: string
5052+
used:
5053+
type: boolean
50075054
TwoFactorEmailCode:
50085055
title: TwoFactorEmailCode
50095056
type: object
@@ -10067,6 +10114,8 @@ components:
1006710114
properties:
1006810115
email:
1006910116
type: string
10117+
unsubscribe:
10118+
type: boolean
1007010119
birthday:
1007110120
type: string
1007210121
format: date
@@ -10099,6 +10148,22 @@ components:
1009910148
description: MUST be a valid VRChat /file/ url.
1010010149
example: https://api.vrchat.cloud/api/1/file/file_76dc2964-0ce8-41df-b2e7-8edf994fee31/1
1010110150
minLength: 0
10151+
contentFilters:
10152+
description: These tags begin with `content_` and control content gating
10153+
type: array
10154+
items:
10155+
$ref: '#/components/schemas/Tag'
10156+
displayName:
10157+
description: MUST specify currentPassword as well to change display name
10158+
type: string
10159+
revertDisplayName:
10160+
description: MUST specify currentPassword as well to revert display name
10161+
type: boolean
10162+
password:
10163+
description: MUST specify currentPassword as well to change password
10164+
type: string
10165+
currentPassword:
10166+
type: string
1010210167
LimitedUserGroups:
1010310168
title: LimitedUserGroups
1010410169
type: object
@@ -10814,6 +10879,12 @@ components:
1081410879
type: string
1081510880
example: twoFactorAuth=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx; Expires=Tue, 01 Jan 2030 00:00:00 GMT; Path=/; HttpOnly
1081610881
description: Provides a `twoFactorAuth` cookie, which can be used to bypasses the 2FA requirement for future logins on the same device.
10882+
Get2FARecoveryCodesResponse:
10883+
description: Returns the two factor recovery codes
10884+
content:
10885+
application/json:
10886+
schema:
10887+
$ref: '#/components/schemas/TwoFactorRecoveryCodes'
1081710888
Verify2FAEmailCodeResponse:
1081810889
description: OK
1081910890
content:
@@ -12268,6 +12339,12 @@ components:
1226812339
application/json:
1226912340
schema:
1227012341
$ref: '#/components/schemas/User'
12342+
CurrentPasswordRequiredError:
12343+
description: Error response when a user attempts to change a property without supplying their current password.
12344+
content:
12345+
application/json:
12346+
schema:
12347+
$ref: '#/components/schemas/Error'
1227112348
LimitedUserGroupListResponse:
1227212349
description: Returns a list of LimitedUserGroups objects.
1227312350
content:

‎openapi.yaml‎

Lines changed: 86 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,26 @@ paths:
244244
security:
245245
- authCookie: []
246246
parameters: []
247+
/auth/user/twofactorauth/otp:
248+
get:
249+
summary: Get 2FA Recovery codes
250+
operationId: getRecoveryCodes
251+
x-codeSamples:
252+
- lang: cURL
253+
source: |-
254+
curl -X GET "https://api.vrchat.cloud/api/1/auth/user/twofactorauth/otp" \
255+
-H "Content-Type: application/json" \
256+
-b "auth={authCookie}"
257+
responses:
258+
'200':
259+
$ref: '#/components/responses/Get2FARecoveryCodesResponse'
260+
'401':
261+
$ref: '#/components/responses/MissingCredentialsError'
262+
description: Gets the OTP (One Time Password) recovery codes for accounts with 2FA-protection enabled.
263+
tags:
264+
- authentication
265+
security:
266+
- authCookie: []
247267
/auth/twofactorauth/otp/verify:
248268
post:
249269
summary: Verify 2FA code with Recovery code
@@ -2998,7 +3018,7 @@ paths:
29983018
description: |-
29993019
Close an instance or update the closedAt time when it will be closed.
30003020
3001-
You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-moderate` permission.
3021+
You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-manage` permission.
30023022
responses:
30033023
'200':
30043024
$ref: '#/components/responses/InstanceResponse'
@@ -3807,6 +3827,8 @@ paths:
38073827
responses:
38083828
'200':
38093829
$ref: '#/components/responses/CurrentUserResponse'
3830+
'400':
3831+
$ref: '#/components/responses/CurrentPasswordRequiredError'
38103832
'401':
38113833
$ref: '#/components/responses/MissingCredentialsError'
38123834
description: Update a users information such as the email and birthday.
@@ -4592,6 +4614,14 @@ components:
45924614
- badgeImageUrl
45934615
- badgeName
45944616
- showcased
4617+
Tag:
4618+
description: |-
4619+
Tags are a way to grant various access, assign restrictions or other kinds of metadata to various to objects such as worlds, users and avatars.
4620+
4621+
System tags starting with `system_` are granted automatically by the system, while admin tags with `admin_` are granted manually. More prefixes such as `language_ ` (to indicate that a player can speak the tagged language), and `author_tag_` (provided by a world author for search and sorting) exist as well.
4622+
minLength: 1
4623+
title: Tag
4624+
type: string
45954625
AvatarID:
45964626
example: avtr_912d66a4-4714-43b8-8407-7de2cafbf55b
45974627
title: AvatarID
@@ -4606,14 +4636,6 @@ components:
46064636
example: https://api.vrchat.cloud/api/1/image/file_aae83ed9-d42d-4d72-9f4b-9f1e41ed17e1/1/256
46074637
title: CurrentAvatarThumbnailImageUrl
46084638
type: string
4609-
Tag:
4610-
description: |-
4611-
Tags are a way to grant various access, assign restrictions or other kinds of metadata to various to objects such as worlds, users and avatars.
4612-
4613-
System tags starting with `system_` are granted automatically by the system, while admin tags with `admin_` are granted manually. More prefixes such as `language_ ` (to indicate that a player can speak the tagged language), and `author_tag_` (provided by a world author for search and sorting) exist as well.
4614-
minLength: 1
4615-
title: Tag
4616-
type: string
46174639
DeveloperType:
46184640
default: none
46194641
description: |-
@@ -4778,6 +4800,11 @@ components:
47784800
type: array
47794801
items:
47804802
type: string
4803+
contentFilters:
4804+
description: These tags begin with `content_` and control content gating
4805+
type: array
4806+
items:
4807+
$ref: '#/components/schemas/Tag'
47814808
currentAvatar:
47824809
$ref: '#/components/schemas/AvatarID'
47834810
currentAvatarImageUrl:
@@ -5004,6 +5031,26 @@ components:
50045031
type: boolean
50055032
required:
50065033
- verified
5034+
TwoFactorRecoveryCodes:
5035+
title: TwoFactorRecoveryCodes
5036+
type: object
5037+
properties:
5038+
requiresTwoFactorAuth:
5039+
type: array
5040+
items:
5041+
type: string
5042+
otp:
5043+
type: array
5044+
items:
5045+
type: object
5046+
required:
5047+
- code
5048+
- used
5049+
properties:
5050+
code:
5051+
type: string
5052+
used:
5053+
type: boolean
50075054
TwoFactorEmailCode:
50085055
title: TwoFactorEmailCode
50095056
type: object
@@ -10067,6 +10114,8 @@ components:
1006710114
properties:
1006810115
email:
1006910116
type: string
10117+
unsubscribe:
10118+
type: boolean
1007010119
birthday:
1007110120
type: string
1007210121
format: date
@@ -10099,6 +10148,22 @@ components:
1009910148
description: MUST be a valid VRChat /file/ url.
1010010149
example: https://api.vrchat.cloud/api/1/file/file_76dc2964-0ce8-41df-b2e7-8edf994fee31/1
1010110150
minLength: 0
10151+
contentFilters:
10152+
description: These tags begin with `content_` and control content gating
10153+
type: array
10154+
items:
10155+
$ref: '#/components/schemas/Tag'
10156+
displayName:
10157+
description: MUST specify currentPassword as well to change display name
10158+
type: string
10159+
revertDisplayName:
10160+
description: MUST specify currentPassword as well to revert display name
10161+
type: boolean
10162+
password:
10163+
description: MUST specify currentPassword as well to change password
10164+
type: string
10165+
currentPassword:
10166+
type: string
1010210167
LimitedUserGroups:
1010310168
title: LimitedUserGroups
1010410169
type: object
@@ -10814,6 +10879,12 @@ components:
1081410879
type: string
1081510880
example: twoFactorAuth=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx; Expires=Tue, 01 Jan 2030 00:00:00 GMT; Path=/; HttpOnly
1081610881
description: Provides a `twoFactorAuth` cookie, which can be used to bypasses the 2FA requirement for future logins on the same device.
10882+
Get2FARecoveryCodesResponse:
10883+
description: Returns the two factor recovery codes
10884+
content:
10885+
application/json:
10886+
schema:
10887+
$ref: '#/components/schemas/TwoFactorRecoveryCodes'
1081710888
Verify2FAEmailCodeResponse:
1081810889
description: OK
1081910890
content:
@@ -12268,6 +12339,12 @@ components:
1226812339
application/json:
1226912340
schema:
1227012341
$ref: '#/components/schemas/User'
12342+
CurrentPasswordRequiredError:
12343+
description: Error response when a user attempts to change a property without supplying their current password.
12344+
content:
12345+
application/json:
12346+
schema:
12347+
$ref: '#/components/schemas/Error'
1227112348
LimitedUserGroupListResponse:
1227212349
description: Returns a list of LimitedUserGroups objects.
1227312350
content:

0 commit comments

Comments
 (0)