EggyByte Server
  1. UserService
EggyByte Server
  • Default module
    • 项目介绍
    • 用户协议
    • 隐私政策
    • SuperDungeon
      • 超能魔盗团 隐私政策
      • User
        • Get User Data
        • Free Lottery
        • Paid Lottery
        • Sell Artwork
        • Find Top Users
        • Get Initial Data
        • Get Access
        • Change Name
      • Rank
        • Update
        • Find Top Users
      • Local
      • Remote
    • EggyByte
      • Account
        • Login
        • Register
        • Login Or Register
        • Access
        • Buy
        • Get Public Access
        • Formal Register
      • Game
        • Save Data
        • Load Data
      • Test
        • Random String
        • Get Map Json
      • Crypto
        • Compute Hash
        • Encrypt
        • Encrypt Map
        • Decrypt
      • Ad
        • Show
        • Debug
        • Impression Callback
      • User
        • Lock Test
        • Get User Data
        • Open Chest
      • Admin
        • Create Api Roles Copy
        • Create Api Roles Copy Copy
        • Delete Api Roles
        • Create Api Roles
      • Database
        • Update Mongo Users
        • List Databases
        • List Collections
        • List Mongo Users
        • Get Collection Stats
        • Get Collection Info
        • Get Paginated Documents
        • Create Mongo Users
        • Create Mongo Databases
      • Mailing
        • Send Mail
        • Send Captcha
        • Check Captcha
      • ThirdParty
        • Connect Url
        • Callback
        • Payment Link
    • 1
    • Untitled Endpoint
      GET
    • Untitled Endpoint
      POST
    • Setup
      POST
    • Create Database
      POST
    • Get Card
      GET
    • Create Question
      POST
    • Create Collection
      POST
    • Get Dashboards
      GET
    • Get Dashboard
      GET
    • Get Dashboard Copy
      POST
    • Untitled Endpoint
      GET
    • Untitled Endpoint
      GET
  • auth/v1/auth.proto
    • AuthService
      • GetJWKS returns the JSON Web Key Set for token validation
      • GetOIDCDiscovery returns the OIDC discovery document
      • Authorize initiates the OAuth/OIDC authorization flow
      • Authorize initiates the OAuth/OIDC authorization flow
      • IntrospectToken validates and returns information about a token (RFC 7662)
      • RevokeToken revokes an access or refresh token (RFC 7009)
      • Token exchanges authorization code or refresh token for access tokens
      • GetUserInfo returns user information from a valid access token
      • GetUserInfo returns user information from a valid access token
      • ListClients lists all OIDC clients
      • RegisterClient registers a new OIDC client
      • DeleteClient deletes an OIDC client
      • UpdateClient updates an existing OIDC client
      • Authenticate user credentials and return tokens (for password grant)
      • Logout invalidates user tokens and sessions
      • RefreshToken refreshes an access token using a refresh token
      • ListRoles lists all roles
      • CreateRole creates a new role
      • DeleteRole deletes a role
      • UpdateRole updates an existing role
      • AssignUserRole assigns a role to a user
      • RevokeUserRole revokes a role from a user
  • user/v1/user.proto
    • UserService
      • ListUsers retrieves a paginated list of users (admin only)
        GET
      • CreateUser creates a new user account (called by Auth service after successful registration)
        POST
      • SearchUsers searches users by criteria
        POST
      • GetUserStats retrieves user statistics
        GET
      • SendVerificationEmail sends a verification code to user's email
        POST
      • VerifyEmail verifies user's email with verification code
        POST
      • GetUser retrieves a user's profile
        GET
      • UpdateUser updates basic user information
        PATCH
      • ActivateUser activates a user account
        POST
      • ListUserAddresses lists all user addresses
        GET
      • AddUserAddress adds a new address for the user
        POST
      • DeleteUserAddress deletes a user address
        DELETE
      • UpdateUserAddress updates an existing user address
        PATCH
      • BanUser bans a user account permanently
        POST
      • DeactivateUser deactivates a user account (soft delete)
        POST
      • UpdateUserPreferences updates user's preferences
        PATCH
      • GetUserProfile retrieves a user's complete profile (including extended info)
        GET
      • UpdateUserProfile updates user's extended profile
        PATCH
      • SuspendUser suspends a user account temporarily
        POST
  1. UserService

ListUsers retrieves a paginated list of users (admin only)

GET
/v1/user

Request

Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/user?pageSize&pageToken&filter&orderBy'

Responses

🟢200OK
application/json
A successful response.
Body

Example
{
    "users": [
        {
            "userId": "string",
            "email": "string",
            "displayName": "string",
            "identity": "IDENTITY_UNSPECIFIED",
            "role": "USER_ROLE_UNSPECIFIED",
            "permissions": [
                "string"
            ],
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "status": "USER_STATUS_UNSPECIFIED",
            "emailVerified": true,
            "phone": "string",
            "avatarUrl": "string",
            "timezone": "string",
            "language": "string"
        }
    ],
    "nextPageToken": "string",
    "totalCount": 0
}
🟢200Success
Modified at 2025-09-16 22:46:40
Previous
RevokeUserRole revokes a role from a user
Next
CreateUser creates a new user account (called by Auth service after successful registration)
Built with