2.2 KiB
2.2 KiB
name, description
| name | description |
|---|---|
| auth-routes | Handle 6 OpenAPI operation(s) under /api/v1/auth for the auth route group. |
auth API Routes
Handle 6 OpenAPI operation(s) under /api/v1/auth for the auth route group.
Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.
Deployment auth note:
- Agent calls use required consumer setup secret
LEARNHOUSE_AUTH. POST /api/v1/auth/loginacceptsapplication/x-www-form-urlencodedcredentials and returnsaccess_token/refresh_tokenundertokens, while also settingLH_accessandLH_refreshcookies.- For subsequent API calls, set
LEARNHOUSE_AUTHtoBearer <access_token>or a Cookie header containingLH_access/LH_refresh.
Operations
login_api_v1_auth_login_post
- Operation ID:
login_api_v1_auth_login_post - Route:
POST /api/v1/auth/login - Mode: WRITE
- Summary: Log in with email and password
- Body: JSON request body accepted.
logout_api_v1_auth_logout_delete
- Operation ID:
logout_api_v1_auth_logout_delete - Route:
DELETE /api/v1/auth/logout - Mode: WRITE
- Summary: Log out the current user
third_party_login_api_v1_auth_oauth_post
- Operation ID:
third_party_login_api_v1_auth_oauth_post - Route:
POST /api/v1/auth/oauth - Mode: WRITE
- Summary: Log in via third-party provider
- Parameters:
org_idinquery
- Body: JSON request body accepted.
refresh_api_v1_auth_refresh_get
- Operation ID:
refresh_api_v1_auth_refresh_get - Route:
GET /api/v1/auth/refresh - Mode: READ
- Summary: Refresh access token
api_resend_verification_email_api_v1_auth_resend_veri_048a435ed9
- Operation ID:
api_resend_verification_email_api_v1_auth_resend_verification_post - Route:
POST /api/v1/auth/resend-verification - Mode: WRITE
- Summary: Resend verification email
- Body: JSON request body accepted.
api_verify_email_api_v1_auth_verify_email_post
- Operation ID:
api_verify_email_api_v1_auth_verify_email_post - Route:
POST /api/v1/auth/verify-email - Mode: WRITE
- Summary: Verify user email
- Body: JSON request body accepted.