216 lines
7.3 KiB
Markdown
216 lines
7.3 KiB
Markdown
---
|
|
name: users-routes
|
|
description: Handle 22 OpenAPI operation(s) under /api/v1/users for the users route group.
|
|
---
|
|
|
|
# users API Routes
|
|
|
|
Handle 22 OpenAPI operation(s) under /api/v1/users for the users 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.
|
|
|
|
## Operations
|
|
|
|
### api_create_user_without_org_api_v1_users_post
|
|
|
|
- Operation ID: `api_create_user_without_org_api_v1_users_post`
|
|
- Route: `POST /api/v1/users/`
|
|
- Mode: WRITE
|
|
- Summary: Create user without organization
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_get_authorization_status_api_v1_users_authorize_r_0a440f1ada
|
|
|
|
- Operation ID: `api_get_authorization_status_api_v1_users_authorize_ressource_ressource_uuid_act`
|
|
- Route: `GET /api/v1/users/authorize/ressource/{ressource_uuid}/action/{action}`
|
|
- Mode: READ
|
|
- Summary: Check authorization for resource action
|
|
- Parameters:
|
|
- `ressource_uuid` in `path` required
|
|
- `action` in `path` required
|
|
|
|
### api_update_user_password_api_v1_users_change_password_f5dd4723f7
|
|
|
|
- Operation ID: `api_update_user_password_api_v1_users_change_password_user_id_put`
|
|
- Route: `PUT /api/v1/users/change_password/{user_id}`
|
|
- Mode: WRITE
|
|
- Summary: Change user password
|
|
- Parameters:
|
|
- `user_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_get_user_by_id_api_v1_users_id_user_id_get
|
|
|
|
- Operation ID: `api_get_user_by_id_api_v1_users_id_user_id_get`
|
|
- Route: `GET /api/v1/users/id/{user_id}`
|
|
- Mode: READ
|
|
- Summary: Get user by ID
|
|
- Parameters:
|
|
- `user_id` in `path` required
|
|
|
|
### api_get_current_user_api_v1_users_profile_get
|
|
|
|
- Operation ID: `api_get_current_user_api_v1_users_profile_get`
|
|
- Route: `GET /api/v1/users/profile`
|
|
- Mode: READ
|
|
- Summary: Get current user profile
|
|
|
|
### api_change_password_with_reset_code_v2_api_v1_users_r_9e5bb417e3
|
|
|
|
- Operation ID: `api_change_password_with_reset_code_v2_api_v1_users_reset_password_change_passwo`
|
|
- Route: `POST /api/v1/users/reset_password/change_password`
|
|
- Mode: WRITE
|
|
- Summary: Change password with reset code
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_change_password_with_reset_code_api_v1_users_rese_dd97d2e9a8
|
|
|
|
- Operation ID: `api_change_password_with_reset_code_api_v1_users_reset_password_change_password_`
|
|
- Route: `POST /api/v1/users/reset_password/change_password/{email}`
|
|
- Mode: WRITE
|
|
- Summary: Change password with reset code (legacy path)
|
|
- Parameters:
|
|
- `email` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_change_password_with_reset_code_platform_v2_api_v_b1301db94f
|
|
|
|
- Operation ID: `api_change_password_with_reset_code_platform_v2_api_v1_users_reset_password_plat`
|
|
- Route: `POST /api/v1/users/reset_password/platform/change_password`
|
|
- Mode: WRITE
|
|
- Summary: Change platform password with reset code
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_change_password_with_reset_code_platform_api_v1_u_985bafaf3c
|
|
|
|
- Operation ID: `api_change_password_with_reset_code_platform_api_v1_users_reset_password_platfor`
|
|
- Route: `POST /api/v1/users/reset_password/platform/change_password/{email}`
|
|
- Mode: WRITE
|
|
- Summary: Change platform password with reset code (legacy path)
|
|
- Parameters:
|
|
- `email` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_send_password_reset_email_platform_v2_api_v1_user_c7f6ef5fb4
|
|
|
|
- Operation ID: `api_send_password_reset_email_platform_v2_api_v1_users_reset_password_platform_s`
|
|
- Route: `POST /api/v1/users/reset_password/platform/send_reset_code`
|
|
- Mode: WRITE
|
|
- Summary: Send platform password reset code
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_send_password_reset_email_platform_api_v1_users_r_7f7d4ea238
|
|
|
|
- Operation ID: `api_send_password_reset_email_platform_api_v1_users_reset_password_platform_send`
|
|
- Route: `POST /api/v1/users/reset_password/platform/send_reset_code/{email}`
|
|
- Mode: WRITE
|
|
- Summary: Send platform password reset code (legacy path)
|
|
- Parameters:
|
|
- `email` in `path` required
|
|
|
|
### api_send_password_reset_email_v2_api_v1_users_reset_p_c85dfacd2d
|
|
|
|
- Operation ID: `api_send_password_reset_email_v2_api_v1_users_reset_password_send_reset_code_pos`
|
|
- Route: `POST /api/v1/users/reset_password/send_reset_code`
|
|
- Mode: WRITE
|
|
- Summary: Send password reset code
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_send_password_reset_email_api_v1_users_reset_pass_fb3b355f5e
|
|
|
|
- Operation ID: `api_send_password_reset_email_api_v1_users_reset_password_send_reset_code_email_`
|
|
- Route: `POST /api/v1/users/reset_password/send_reset_code/{email}`
|
|
- Mode: WRITE
|
|
- Summary: Send password reset code (legacy path)
|
|
- Parameters:
|
|
- `email` in `path` required
|
|
- `org_id` in `query` required
|
|
|
|
### api_get_current_user_session_api_v1_users_session_get
|
|
|
|
- Operation ID: `api_get_current_user_session_api_v1_users_session_get`
|
|
- Route: `GET /api/v1/users/session`
|
|
- Mode: READ
|
|
- Summary: Get current user session
|
|
|
|
### api_update_avatar_user_api_v1_users_update_avatar_user_id_put
|
|
|
|
- Operation ID: `api_update_avatar_user_api_v1_users_update_avatar_user_id_put`
|
|
- Route: `PUT /api/v1/users/update_avatar/{user_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update user avatar
|
|
- Parameters:
|
|
- `user_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_delete_user_api_v1_users_user_id_user_id_delete
|
|
|
|
- Operation ID: `api_delete_user_api_v1_users_user_id_user_id_delete`
|
|
- Route: `DELETE /api/v1/users/user_id/{user_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete user
|
|
- Parameters:
|
|
- `user_id` in `path` required
|
|
|
|
### api_get_user_by_username_api_v1_users_username_username_get
|
|
|
|
- Operation ID: `api_get_user_by_username_api_v1_users_username_username_get`
|
|
- Route: `GET /api/v1/users/username/{username}`
|
|
- Mode: READ
|
|
- Summary: Get user by username
|
|
- Parameters:
|
|
- `username` in `path` required
|
|
|
|
### api_get_user_by_uuid_api_v1_users_uuid_user_uuid_get
|
|
|
|
- Operation ID: `api_get_user_by_uuid_api_v1_users_uuid_user_uuid_get`
|
|
- Route: `GET /api/v1/users/uuid/{user_uuid}`
|
|
- Mode: READ
|
|
- Summary: Get user by UUID
|
|
- Parameters:
|
|
- `user_uuid` in `path` required
|
|
|
|
### api_create_user_with_orgid_api_v1_users_org_id_post
|
|
|
|
- Operation ID: `api_create_user_with_orgid_api_v1_users_org_id_post`
|
|
- Route: `POST /api/v1/users/{org_id}`
|
|
- Mode: WRITE
|
|
- Summary: Create user in organization
|
|
- Parameters:
|
|
- `org_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_create_user_with_orgid_and_invite_api_v1_users_or_827b99a284
|
|
|
|
- Operation ID: `api_create_user_with_orgid_and_invite_api_v1_users_org_id_invite_invite_code_pos`
|
|
- Route: `POST /api/v1/users/{org_id}/invite/{invite_code}`
|
|
- Mode: WRITE
|
|
- Summary: Create user with invite code
|
|
- Parameters:
|
|
- `invite_code` in `path` required
|
|
- `org_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_update_user_api_v1_users_user_id_put
|
|
|
|
- Operation ID: `api_update_user_api_v1_users_user_id_put`
|
|
- Route: `PUT /api/v1/users/{user_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update user
|
|
- Parameters:
|
|
- `user_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### api_get_user_courses_api_v1_users_user_id_courses_get
|
|
|
|
- Operation ID: `api_get_user_courses_api_v1_users_user_id_courses_get`
|
|
- Route: `GET /api/v1/users/{user_id}/courses`
|
|
- Mode: READ
|
|
- Summary: List courses for user
|
|
- Parameters:
|
|
- `user_id` in `path` required
|
|
- `page` in `query`
|
|
- `limit` in `query`
|