- 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 validationGET
- GetOIDCDiscovery returns the OIDC discovery documentGET
- Authorize initiates the OAuth/OIDC authorization flowGET
- Authorize initiates the OAuth/OIDC authorization flowPOST
- IntrospectToken validates and returns information about a token (RFC 7662)POST
- RevokeToken revokes an access or refresh token (RFC 7009)POST
- Token exchanges authorization code or refresh token for access tokensPOST
- GetUserInfo returns user information from a valid access tokenGET
- GetUserInfo returns user information from a valid access tokenPOST
- ListClients lists all OIDC clientsGET
- RegisterClient registers a new OIDC clientPOST
- DeleteClient deletes an OIDC clientDELETE
- UpdateClient updates an existing OIDC clientPUT
- Authenticate user credentials and return tokens (for password grant)POST
- Logout invalidates user tokens and sessionsPOST
- RefreshToken refreshes an access token using a refresh tokenPOST
- ListRoles lists all rolesGET
- CreateRole creates a new rolePOST
- DeleteRole deletes a roleDELETE
- UpdateRole updates an existing rolePUT
- AssignUserRole assigns a role to a userPOST
- RevokeUserRole revokes a role from a userDELETE
- user/v1/user.proto
- UserService
- ListUsers retrieves a paginated list of users (admin only)
- CreateUser creates a new user account (called by Auth service after successful registration)
- SearchUsers searches users by criteria
- GetUserStats retrieves user statistics
- SendVerificationEmail sends a verification code to user's email
- VerifyEmail verifies user's email with verification code
- GetUser retrieves a user's profile
- UpdateUser updates basic user information
- ActivateUser activates a user account
- ListUserAddresses lists all user addresses
- AddUserAddress adds a new address for the user
- DeleteUserAddress deletes a user address
- UpdateUserAddress updates an existing user address
- BanUser bans a user account permanently
- DeactivateUser deactivates a user account (soft delete)
- UpdateUserPreferences updates user's preferences
- GetUserProfile retrieves a user's complete profile (including extended info)
- UpdateUserProfile updates user's extended profile
- SuspendUser suspends a user account temporarily
- UserService
Authenticate user credentials and return tokens (for password grant)
POST
/v1/auth/login
Request
Body Params application/json
Example
{
"email": "string",
"password": "string",
"clientId": "string",
"rememberMe": true
}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/auth/login' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "string",
"password": "string",
"clientId": "string",
"rememberMe": true
}'Responses
🟢200OK
application/json
Body
Example
{
"user": {
"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"
},
"accessToken": "string",
"refreshToken": "string",
"expiresIn": 0
}🟢200Success
Modified at 2025-09-16 19:37:45