1. authentication
vrchat-api
  • system
    • Check API Health
      GET
    • Fetch API Config
      GET
    • Current Online Users
      GET
    • Current System Time
      GET
    • Show Information Notices
      GET
    • Download CSS
      GET
    • Download JavaScript
      GET
  • authentication
    • Check User Exists
      GET
    • Verify Auth Token
      GET
    • Logout
      PUT
    • Delete User
      PUT
    • Login and/or Get Current User Info
      GET
    • Verify 2FA code
      POST
    • Verify 2FA code with Recovery code
      POST
    • Verify 2FA email code
      POST
  • avatars
    • Get Own Avatar
      GET
    • Select Avatar
      PUT
    • Select Fallback Avatar
      PUT
    • Enqueue Impostor generation
      POST
    • Get Impostor Queue Stats
      GET
    • Delete generated Impostor
      DELETE
    • List Favorited Avatars
      GET
    • List Licensed Avatars
      GET
    • Search Avatars
      GET
    • Create Avatar
      POST
    • Get Avatar
      GET
    • Delete Avatar
      DELETE
    • Update Avatar
      PUT
  • files
    • Check FileData Upload Status
    • Get File Version Analysis
    • Get File Version Analysis Security
    • Get File Version Analysis Standard
    • List Files
    • Create File
    • Show File
    • Delete File
    • Create File Version
    • Download File Version
    • Delete File Version
    • Start FileData Upload
    • Finish FileData Upload
  • friends
    • Check Friend Status
    • Unfriend
    • List Friends
    • Send Friend Request
    • Delete Friend Request
  • groups
    • Get Group Audit Logs
    • Unban Group Member
    • Delete Group Gallery Image
    • Get Group Instances
    • Delete User Invite
    • Join Group
    • Leave Group
    • List Group Members
    • List Group Permissions
    • Respond Group Join request
    • Search Group
    • Create Group
    • Get Group Announcement
    • Delete Group Announcement
    • Create Group Announcement
    • Get Group Bans
    • Ban Group Member
    • Create Group Gallery
    • Add Group Gallery Image
    • Get Group Invites Sent
    • Invite User to Group
    • Get Group Member
    • Kick Group Member
    • Update Group Member
    • Add Role to GroupMember
    • Remove Role from GroupMember
    • Delete a Group post
    • Edits a Group post
    • Get Group Roles
    • Create GroupRole
    • Delete Group
    • Get Group by ID
    • Update Group
    • Delete Group Gallery
    • Get Group Gallery Images
    • Update Group Gallery
    • Get posts from a Group
    • Create a post in a Group
    • Cancel Group Join Request
    • Get Group Join Requests
    • Delete Group Role
    • Update Group Role
  • invite
    • List Invite Messages
    • Invite User
    • Invite Myself To Instance
    • Respond Invite
    • Request Invite
    • Get Invite Message
    • Reset Invite Message
    • Update Invite Message
  • notifications
    • Show notification
    • Accept Friend Request
    • Mark Notification As Read
    • Delete Notification
    • Clear All Notifications
    • List Notifications
  • permissions
    • Get Permission
    • Get Assigned Permissions
  • jams
    • Show jam information
    • Show jam submissions
    • Show jams list
  • users
    • Get User by Username
    • Get User Group Requests
    • Get User Feedback
    • Get User Note
    • Get User Group Instances
    • Check User Persistence Exists
    • Delete User Persistence
    • Search All Users
    • Get User by ID
    • Update User Info
    • Get User Groups
    • Get User Notes
    • Update User Note
    • Add User Tags
    • Remove User Tags
    • Update User Badge
    • Get user's current represented group
  • economy
    • List Steam Transactions
    • Get Steam Transaction
    • Get Current Subscriptions
    • List Subscriptions
    • Get License Group
    • Get Product Listing
    • Get User Product Listings
    • List Token Bundles
    • Get Tilia Status
    • Get Tilia TOS Agreement Status
    • Get Balance
  • favorites
    • Remove Favorite
    • List Favorite Groups
    • Get Favorite Limits
    • Show Favorite
    • Show Favorite Group
    • Clear Favorite Group
    • Update Favorite Group
    • List Favorites
    • Add Favorite
  • instances
    • Create Instance
    • Get Instance Short Name
    • Get Instance By Short Name
    • Get Instance
    • Close Instance
  • worlds
    • List Active Worlds
    • List Favorited Worlds
    • List Recent Worlds
    • Get World Metadata
    • Get World Instance
    • Create World
    • Search All Worlds
    • Get World by ID
    • Delete World
    • Update World
    • Get World Publish Status
    • Publish World
    • Unpublish World
  • playermoderation
    • Unmoderate User
    • Search Player Moderations
    • Clear All Player Moderations
    • Moderate User
  • prints
    • Get Own Prints
    • Get Print
    • Delete Print
  • 数据模型
    • Schemas
      • UserID
      • AgeVerified
      • BadgeID
      • AvatarID
      • CurrentAvatarImageUrl
      • CurrentAvatarThumbnailImageUrl
      • Tag
      • WorldID
      • Platform
      • GroupID
      • UnityPackageID
      • TransactionID
      • LicenseGroupID
      • FileID
      • GroupRoleID
      • ProductID
      • ProductListingVariantID
      • FavoriteID
      • FavoriteGroupID
      • GroupShortCode
      • GroupDiscriminator
      • GroupGalleryID
      • GroupMemberID
      • GroupAnnouncementID
      • GroupAuditLogID
      • GroupGalleryImageID
      • InstanceID
      • UdonProductId
      • GroupRoleIDList
      • NotificationID
      • InviteMessageID
      • InstanceOwnerId
      • PermissionID
      • PlayerModerationID
      • FeedbackID
      • PrintID
      • UserNoteID
      • Error
      • AgeVerificationStatus
      • DeveloperType
      • UserState
      • UserStatus
      • Success
      • ReleaseStatus
      • PerformanceRatings
      • SortOption
      • OrderOption
      • TransactionStatus
      • SubscriptionPeriod
      • LicenseType
      • LicenseAction
      • ProductType
      • ProductListingType
      • FavoriteType
      • FavoriteGroupVisibility
      • MIMEType
      • FileStatus
      • NotificationType
      • GroupMemberStatus
      • GroupJoinState
      • GroupPrivacy
      • GroupRoleTemplate
      • GroupPermissions
      • BanGroupMemberRequest
      • AddGroupGalleryImageRequest
      • GroupSearchSort
      • GroupUserVisibility
      • GroupPostVisibility
      • GroupJoinRequestAction
      • InviteMessageType
      • InstanceType
      • InstanceRegion
      • GroupAccessType
      • Region
      • PlayerModerationType
      • ModerateUserRequest
      • DeploymentGroup
      • InfoPushDataArticle
      • NotificationDetailVoteToKick
      • UserExists
      • Response
      • PastDisplayName
      • TwoFactorAuthCode
      • Verify2FAResult
      • TwoFactorEmailCode
      • Verify2FAEmailCodeResult
      • VerifyAuthTokenResult
      • License
      • TiliaStatus
      • ServiceQueueStats
      • TiliaTOS
      • Favorite
      • AddFavoriteRequest
      • UpdateFavoriteGroupRequest
      • FavoriteLimits
      • FileUploadURL
      • GroupInstance
      • CreateGroupInviteRequest
      • UpdateGroupMemberRequest
      • RespondGroupJoinRequest
      • InviteRequest
      • RequestInviteRequest
      • InviteResponse
      • UpdateInviteMessageRequest
      • InstanceShortNameResponse
      • APIConfigAnnouncement
      • PerformanceLimiterInfo
      • PlatformBuildInfo
      • ReportCategory
      • ReportReason
      • InfoPushDataArticleContent
      • UpdateUserNoteRequest
      • LimitedUnityPackage
      • WorldMetadata
      • WorldPublishStatus
      • ChangeUserTagsRequest
      • NotificationDetailInvite
      • UpdateUserBadgeRequest
      • NotificationDetailInviteResponse
      • NotificationDetailRequestInvite
      • NotificationDetailRequestInviteResponse
      • AccountDeletionLog
      • TransactionSteamInfo
      • Balance
      • FavoriteGroup
      • FavoriteGroupLimits
      • FileVersion
      • File
      • CreateFileRequest
      • CreateFileVersionRequest
      • FileAnalysis
      • FriendStatus
      • CreateGroupAnnouncementRequest
      • PaginatedGroupAuditLogEntryList
      • GroupGalleryImage
      • CreateGroupPostRequest
      • InstancePlatforms
      • PlayerModeration
      • APIHealth
      • TransactionSteamWalletInfo
      • ProductListingVariant
      • FileVersionUploadStatus
      • Notification
      • CreateGroupRequest
      • GroupAnnouncement
      • GroupMemberLimitedUser
      • GroupPermission
      • GroupPost
      • CreateGroupRequest
      • UpdateGroupRoleRequest
      • InviteMessage
      • CreateInstanceRequest
      • Permission
      • APIConfigDownloadURLList
      • InfoPushDataClickable
      • InfoPushData
      • Submission
      • Badge
      • CreateAvatarRequest
      • UpdateAvatarRequest
      • Transaction
      • TokenBundle
      • FinishFileDataUploadRequest
      • CreateGroupGalleryRequest
      • UpdateGroupGalleryRequest
      • DynamicContentRow
      • RepresentedGroup
      • FileData
      • GroupMember
      • GroupRole
      • UpdateGroupRequest
      • GroupAuditLogEntry
      • ServiceStatus
      • APIConfigEvents
      • InfoPush
      • UpdateUserRequest
      • Feedback
      • CreateWorldRequest
      • UpdateWorldRequest
      • CurrentUserPresence
      • Subscription
      • LicenseGroup
      • Product
      • LimitedGroup
      • GroupLimitedMember
      • UserNote
      • UserSubscription
      • Print
      • GroupMember
      • LimitedUserGroups
      • GroupMyMember
      • Jam
      • UnityPackage
      • TransactionAgreement
      • LimitedUser
      • SentNotification
      • Avatar
      • LimitedWorld
      • Listing
      • Group
      • FavoritedWorld
      • World
      • Instance
      • User
      • APIConfigConstants
      • FileAnalysisAvatarStats
      • CurrentUser
      • APIConfig
    • Response
      • UserExistsResponse
      • VerifyAuthTokenResponse
      • DeleteUserResponse
      • AvatarResponse
      • CurrentUserResponse
      • TransactionResponse
      • AvatarImpostorEnqueueResponse
      • LicenseGroupResponse
      • AvatarImpostorQueueStatsResponse
      • ProductListingResponse
      • TiliaStatusResponse
      • TiliaTOSResponse
      • BalanceResponse
      • FavoriteResponse
      • FavoriteGroupResponse
      • FavoriteLimitsResponse
      • FileAnalysisResponse
      • GroupResponse
      • GroupAnnouncementResponse
      • GroupAuditLogListResponse
      • GroupMemberResponse
      • GroupGalleryResponse
      • GroupGalleryImageResponse
      • GroupLimitedMemberResponse
      • GroupRoleIDListResponse
      • GroupPostResponse
      • GroupRoleResponse
      • InviteMessageResponse
      • InstanceResponse
      • InstanceShortNameResponse
      • PermissionResponse
      • PlayerModerationResponse
      • APIConfigResponse
      • PrintResponse
      • JamResponse
      • UserResponse
      • UserNoteResponse
      • WorldResponse
      • WorldMetadataResponse
      • WorldPublishStatusResponse
      • CurrentUserLoginResponse
      • UserTagInvalidError
      • Verify2FAResponse
      • Verify2FAEmailCodeResponse
      • AvatarListResponse
      • TransactionListResponse
      • UserSubscriptionListResponse
      • SubscriptionListResponse
      • ProductListingListResponse
      • TokenBundleListResponse
      • FavoriteListResponse
      • FavoriteGroupListResponse
      • FileListResponse
      • LimitedUserListResponse
      • LimitedGroupListResponse
      • GroupMemberListResponse
      • GroupGalleryImageListResponse
      • GroupInstanceListResponse
      • GroupPermissionListResponse
      • GroupRoleListResponse
      • InviteMessageListResponse
      • NotificationListResponse
      • PlayerModerationListResponse
      • CurrentOnlineUsersResponse
      • SystemTimeResponse
      • PrintListResponse
      • JamListResponse
      • SubmissionListResponse
      • LimitedUserGroupListResponse
      • GroupListResponse
      • FeedbackListResponse
      • UserNoteListResponse
      • LimitedWorldListResponse
      • FavoritedWorldListResponse
      • FileUploadURLResponse
      • NotificationResponse
      • FriendStatusResponse
      • InviteMessageGetNegativeSlotError
      • APIHealthResponse
      • UserGroupInstanceListResponse
      • GroupPostsResponse
      • MissingParameterError
      • MissingCredentialsError
      • LogoutSuccess
      • AvatarSeeOtherUserCurrentAvatarError
      • FeaturedSetNotAdminError
      • AvatarNotTaggedAsFallbackError
      • AvatarSeeOtherUserFavoritesError
      • FavoriteAddAlreadyFavoritedError
      • FavoriteAddNotFriendsError
      • FavoriteNotFoundError
      • FavoriteRemovedSuccess
      • FavoriteGroupClearedSuccess
      • FileNotFoundError
      • FileDeletedError
      • FileVersionDeleteInitialError
      • FileVersionDeleteMiddleError
      • FileUploadAlreadyFinishedError
      • FileVersionUploadStatusResponse
      • AnalysisNotYetAvailableError
      • FriendBadRequestError
      • UserDoesntExistError
      • DeleteFriendSuccess
      • DeleteFriendRequestError
      • UnfriendSuccess
      • NotFriendsError
      • GroupNotFoundError
      • DeleteGroupSuccess
      • DeleteGroupAnnouncementSuccess
      • NoPermission
      • BanGroupMemberBadRequestError
      • DeleteGroupGallerySuccess
      • DeleteGroupGalleryImageSuccess
      • GroupGalleryImageDeleteForbiddenError
      • GroupNotMemberError
      • GroupInviteBadRequestError
      • GroupInviteForbiddenError
      • DeleteGroupInviteBadRequestError
      • GroupAlreadyMemberError
      • UsersInvalidSearchError
      • GroupPostResponseSuccess
      • GroupJoinRequestResponseBadRequestError
      • SendNotificationResponse
      • InviteMustBeFriendsError
      • InstanceNotFoundError
      • InviteMessageInvalidSlotNumberError
      • NotAuthorizedActionError
      • InviteMessageGetTooHighSlotError
      • InviteMessageUpdateRateLimitError
      • InviteMessageNoEntryForSlotError
      • InstanceCloseForbiddenError
      • NotificationNotFoundError
      • FriendSuccess
      • AcceptFriendRequestError
      • ClearNotificationsSuccess
      • InvalidAdminCredentialsError
      • PlayerModerationClearAllSuccess
      • PlayerModerationUnmoderatedSuccess
      • DownloadSourceCodeAccessError
      • JamNotFoundError
      • UserMustBeOwnError
      • WorldCreateNotAllowedYetError
      • UnableToRequestOtherUsersPrintsError
      • WorldSeeOtherUserFavoritesError
      • WorldSeeOtherUserRecentsError
      • WorldNotFoundError
      • AvatarNotFoundError
      • InviteResponse400Error
      • FileResponse
      • PermissionListResponse
      • InfoPushListResponse
  1. authentication

Login and/or Get Current User Info

GET
/auth/user
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.
The auth string after Authorization: Basic {string} is a base64-encoded string of the username and password, both individually url-encoded, and then joined with a colon.
base64(urlencode(username):urlencode(password))
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.

请求参数

无

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location '/auth/user'

返回响应

🟢200成功
application/json
OK
Headers

Bodyapplication/json

示例
{
    "ageVerificationStatus": "hidden",
    "ageVerified": true,
    "currentAvatar": "avtr_912d66a4-4714-43b8-8407-7de2cafbf55b",
    "currentAvatarImageUrl": "https://api.vrchat.cloud/api/1/file/file_ae46d521-7281-4b38-b365-804b32a1d6a7/1/file",
    "currentAvatarThumbnailImageUrl": "https://api.vrchat.cloud/api/1/image/file_aae83ed9-d42d-4d72-9f4b-9f1e41ed17e1/1/256",
    "developerType": "none",
    "fallbackAvatar": "avtr_912d66a4-4714-43b8-8407-7de2cafbf55b",
    "homeLocation": "wrld_ba913a96-fac4-4048-a062-9aa5db092812",
    "id": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
    "last_platform": "standalonewindows",
    "presence": {
        "id": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
        "travelingToWorld": "wrld_ba913a96-fac4-4048-a062-9aa5db092812",
        "world": "wrld_ba913a96-fac4-4048-a062-9aa5db092812",
        "avatarThumbnail": "string",
        "currentAvatarTags": "string",
        "displayName": "string",
        "groups": [
            "grp_71a7ff59-112c-4e78-a990-c7cc650776e5"
        ],
        "instance": "string",
        "instanceType": "string",
        "isRejoining": "string",
        "platform": "string",
        "profilePicOverride": "string",
        "status": "string",
        "travelingToInstance": "string",
        "userIcon": "string"
    },
    "state": "offline",
    "status": "offline",
    "acceptedTOSVersion": 7,
    "acceptedPrivacyVersion": 0,
    "accountDeletionDate": "2019-08-24",
    "accountDeletionLog": [
        {
            "message": "Deletion requested",
            "deletionScheduled": "2019-08-24T14:15:22.123Z",
            "dateTime": "2019-08-24T14:15:22.123Z"
        }
    ],
    "activeFriends": [
        "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"
    ],
    "allowAvatarCopying": true,
    "badges": [
        {
            "badgeId": "bdg_a60e514a-8cb7-4702-8f24-2786992be1a8",
            "assignedAt": "2019-08-24T14:15:22.123Z",
            "badgeDescription": "string",
            "badgeImageUrl": "string",
            "badgeName": "string",
            "hidden": true,
            "showcased": true,
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "bio": "string",
    "currentAvatarAssetUrl": "string",
    "currentAvatarTags": [
        "string"
    ],
    "date_joined": "2019-08-24",
    "displayName": "string",
    "emailVerified": true,
    "friendKey": "string",
    "friends": [
        "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"
    ],
    "hasBirthday": true,
    "hideContentFilterSettings": true,
    "userLanguage": "string",
    "userLanguageCode": "string",
    "hasEmail": true,
    "hasLoggedInFromClient": true,
    "hasPendingEmail": true,
    "isAdult": true,
    "isBoopingEnabled": true,
    "isFriend": false,
    "last_activity": "2019-08-24T14:15:22.123Z",
    "last_login": "2019-08-24T14:15:22.123Z",
    "last_mobile": "2019-08-24T14:15:22.123Z",
    "obfuscatedEmail": "string",
    "obfuscatedPendingEmail": "string",
    "oculusId": "string",
    "googleId": "string",
    "googleDetails": {},
    "picoId": "string",
    "viveId": "string",
    "offlineFriends": [
        "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"
    ],
    "onlineFriends": [
        "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"
    ],
    "pastDisplayNames": [
        {
            "displayName": "string",
            "updated_at": "2019-08-24T14:15:22.123Z"
        }
    ],
    "profilePicOverride": "string",
    "profilePicOverrideThumbnail": "string",
    "pronouns": "string",
    "queuedInstance": "string",
    "receiveMobileInvitations": true,
    "statusDescription": "string",
    "statusFirstTime": true,
    "steamDetails": {},
    "steamId": "string",
    "tags": [
        "string"
    ],
    "twoFactorAuthEnabled": true,
    "twoFactorAuthEnabledDate": "2019-08-24T14:15:22.123Z",
    "unsubscribe": true,
    "updated_at": "2019-08-24T14:15:22.123Z",
    "userIcon": "string",
    "username": "string",
    "bioLinks": [
        "string"
    ],
    "friendGroupNames": [
        "string"
    ],
    "statusHistory": [
        "string"
    ],
    "platform_history": [
        {
            "isMobile": true,
            "platform": "string",
            "recorded": "2019-08-24T14:15:22.123Z"
        }
    ]
}
🟠401没有权限
修改于 2025-03-27 03:41:57
上一页
Delete User
下一页
Verify 2FA code
Built with