3.9 KiB
3.9 KiB
name, description
| name | description |
|---|---|
| users-routes | Handle 15 OpenAPI operation(s) under /users for the users route group. |
users API Routes
Handle 15 OpenAPI operation(s) under /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
get_users
- Operation ID:
get_users - Route:
GET /users - Mode: READ
- Summary: List enterprise users
- Parameters:
filter_terminqueryuser_typeinqueryexternal_app_user_idinqueryfieldsinqueryoffsetinquerylimitinqueryusemarkerinquerymarkerinquery
post_users
- Operation ID:
post_users - Route:
POST /users - Mode: WRITE
- Summary: Create user
- Parameters:
fieldsinquery
- Body: JSON request body accepted.
get_users_me
- Operation ID:
get_users_me - Route:
GET /users/me - Mode: READ
- Summary: Get current user
- Parameters:
fieldsinquery
post_users_terminate_sessions
- Operation ID:
post_users_terminate_sessions - Route:
POST /users/terminate_sessions - Mode: WRITE
- Summary: Create jobs to terminate users session
- Body: JSON request body accepted.
get_users_id
- Operation ID:
get_users_id - Route:
GET /users/{user_id} - Mode: READ
- Summary: Get user
- Parameters:
user_idinpathrequiredfieldsinquery
put_users_id
- Operation ID:
put_users_id - Route:
PUT /users/{user_id} - Mode: WRITE
- Summary: Update user
- Parameters:
user_idinpathrequiredfieldsinquery
- Body: JSON request body accepted.
delete_users_id
- Operation ID:
delete_users_id - Route:
DELETE /users/{user_id} - Mode: WRITE
- Summary: Delete user
- Parameters:
user_idinpathrequirednotifyinqueryforceinquery
get_users_id_avatar
- Operation ID:
get_users_id_avatar - Route:
GET /users/{user_id}/avatar - Mode: READ
- Summary: Get user avatar
- Parameters:
user_idinpathrequired
post_users_id_avatar
- Operation ID:
post_users_id_avatar - Route:
POST /users/{user_id}/avatar - Mode: WRITE
- Summary: Add or update user avatar
- Parameters:
user_idinpathrequired
- Body: JSON request body accepted.
delete_users_id_avatar
- Operation ID:
delete_users_id_avatar - Route:
DELETE /users/{user_id}/avatar - Mode: WRITE
- Summary: Delete user avatar
- Parameters:
user_idinpathrequired
put_users_id_folders_0
- Operation ID:
put_users_id_folders_0 - Route:
PUT /users/{user_id}/folders/0 - Mode: WRITE
- Summary: Transfer owned folders
- Parameters:
user_idinpathrequiredfieldsinquerynotifyinquery
- Body: JSON request body accepted.
get_users_id_email_aliases
- Operation ID:
get_users_id_email_aliases - Route:
GET /users/{user_id}/email_aliases - Mode: READ
- Summary: List user's email aliases
- Parameters:
user_idinpathrequired
post_users_id_email_aliases
- Operation ID:
post_users_id_email_aliases - Route:
POST /users/{user_id}/email_aliases - Mode: WRITE
- Summary: Create email alias
- Parameters:
user_idinpathrequired
- Body: JSON request body accepted.
delete_users_id_email_aliases_id
- Operation ID:
delete_users_id_email_aliases_id - Route:
DELETE /users/{user_id}/email_aliases/{email_alias_id} - Mode: WRITE
- Summary: Remove email alias
- Parameters:
user_idinpathrequiredemail_alias_idinpathrequired
get_users_id_memberships
- Operation ID:
get_users_id_memberships - Route:
GET /users/{user_id}/memberships - Mode: READ
- Summary: List user's groups
- Parameters:
user_idinpathrequiredlimitinqueryoffsetinquery