- Default module
- 项目介绍
- 用户协议
- 隐私政策
- SuperDungeon
- EggyByte
- 1
- Untitled EndpointGET
- Untitled EndpointPOST
- SetupPOST
- Create DatabasePOST
- Get CardGET
- Create QuestionPOST
- Create CollectionPOST
- Get DashboardsGET
- Get DashboardGET
- Get Dashboard CopyPOST
- Untitled EndpointGET
- Untitled EndpointGET
- 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
- AuthService
- 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 criteriaPOST
- GetUserStats retrieves user statisticsGET
- SendVerificationEmail sends a verification code to user's emailPOST
- VerifyEmail verifies user's email with verification codePOST
- GetUser retrieves a user's profileGET
- UpdateUser updates basic user informationPATCH
- ActivateUser activates a user accountPOST
- ListUserAddresses lists all user addressesGET
- AddUserAddress adds a new address for the userPOST
- DeleteUserAddress deletes a user addressDELETE
- UpdateUserAddress updates an existing user addressPATCH
- BanUser bans a user account permanentlyPOST
- DeactivateUser deactivates a user account (soft delete)POST
- UpdateUserPreferences updates user's preferencesPATCH
- GetUserProfile retrieves a user's complete profile (including extended info)GET
- UpdateUserProfile updates user's extended profilePATCH
- SuspendUser suspends a user account temporarilyPOST
SearchUsers searches users by criteria
POST
/v1/user/search
Request
Body Params application/json
Example
{
"query": "string",
"criteria": {
"searchEmail": true,
"searchDisplayName": true,
"searchPhone": true,
"status": "USER_STATUS_UNSPECIFIED",
"role": "USER_ROLE_UNSPECIFIED"
},
"pageSize": 0,
"pageToken": "string"
}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 POST '/v1/user/search' \
--header 'Content-Type: application/json' \
--data-raw '{
"query": "string",
"criteria": {
"searchEmail": true,
"searchDisplayName": true,
"searchPhone": true,
"status": "USER_STATUS_UNSPECIFIED",
"role": "USER_ROLE_UNSPECIFIED"
},
"pageSize": 0,
"pageToken": "string"
}'Responses
🟢200OK
application/json
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