16 KiB
16 KiB
name, description
| name | description |
|---|---|
| user-management-routes | Handle 52 OpenAPI operation(s) under /user_management for the user management route group. |
user management API Routes
Handle 52 OpenAPI operation(s) under /user_management for the user management 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
userland_sessions_controller_authenticate_0
- Operation ID:
userland_sessions_controller_authenticate_0 - Route:
POST /user_management/authenticate - Mode: WRITE
- Summary: Authenticate
- Body: JSON request body accepted.
userland_sso_controller_authorize
- Operation ID:
userland_sso_controller_authorize - Route:
GET /user_management/authorize - Mode: READ
- Summary: Get an authorization URL
- Parameters:
code_challenge_methodinquerycode_challengeinquerydomain_hintinqueryconnection_idinqueryprovider_query_paramsinqueryprovider_scopesinqueryinvitation_tokeninqueryscreen_hintinquerylogin_hintinqueryproviderinquerypromptinquerystateinqueryorganization_idinqueryresponse_typeinqueryrequiredredirect_uriinqueryrequiredclient_idinqueryrequired
userland_sso_controller_device_authorization
- Operation ID:
userland_sso_controller_device_authorization - Route:
POST /user_management/authorize/device - Mode: WRITE
- Summary: Get device authorization URL
- Body: JSON request body accepted.
cors_origins_controller_create_cors_origin
- Operation ID:
cors_origins_controller_create_cors_origin - Route:
POST /user_management/cors_origins - Mode: WRITE
- Summary: Create a CORS origin
- Body: JSON request body accepted.
userland_users_controller_get_email_verification
- Operation ID:
userland_users_controller_get_email_verification - Route:
GET /user_management/email_verification/{id} - Mode: READ
- Summary: Get an email verification code
- Parameters:
idinpathrequired
userland_user_invites_controller_list
- Operation ID:
userland_user_invites_controller_list - Route:
GET /user_management/invitations - Mode: READ
- Summary: List invitations
- Parameters:
beforeinqueryafterinquerylimitinqueryorderinqueryorganization_idinqueryemailinquery
userland_user_invites_controller_create
- Operation ID:
userland_user_invites_controller_create - Route:
POST /user_management/invitations - Mode: WRITE
- Summary: Send an invitation
- Body: JSON request body accepted.
userland_user_invites_controller_get_by_token
- Operation ID:
userland_user_invites_controller_get_by_token - Route:
GET /user_management/invitations/by_token/{token} - Mode: READ
- Summary: Find an invitation by token
- Parameters:
tokeninpathrequired
userland_user_invites_controller_get
- Operation ID:
userland_user_invites_controller_get - Route:
GET /user_management/invitations/{id} - Mode: READ
- Summary: Get an invitation
- Parameters:
idinpathrequired
userland_user_invites_controller_accept
- Operation ID:
userland_user_invites_controller_accept - Route:
POST /user_management/invitations/{id}/accept - Mode: WRITE
- Summary: Accept an invitation
- Parameters:
idinpathrequired
userland_user_invites_controller_resend
- Operation ID:
userland_user_invites_controller_resend - Route:
POST /user_management/invitations/{id}/resend - Mode: WRITE
- Summary: Resend an invitation
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
userland_user_invites_controller_revoke
- Operation ID:
userland_user_invites_controller_revoke - Route:
POST /user_management/invitations/{id}/revoke - Mode: WRITE
- Summary: Revoke an invitation
- Parameters:
idinpathrequired
jwt_templates_controller_get_jwt_template
- Operation ID:
jwt_templates_controller_get_jwt_template - Route:
GET /user_management/jwt_template - Mode: READ
- Summary: Get JWT template
jwt_templates_controller_update_jwt_template
- Operation ID:
jwt_templates_controller_update_jwt_template - Route:
PUT /user_management/jwt_template - Mode: WRITE
- Summary: Update JWT template
- Body: JSON request body accepted.
userland_magic_auth_controller_send_magic_auth_code_and_return
- Operation ID:
userland_magic_auth_controller_send_magic_auth_code_and_return - Route:
POST /user_management/magic_auth - Mode: WRITE
- Summary: Create a Magic Auth code
- Body: JSON request body accepted.
userland_magic_auth_controller_get
- Operation ID:
userland_magic_auth_controller_get - Route:
GET /user_management/magic_auth/{id} - Mode: READ
- Summary: Get Magic Auth code details
- Parameters:
idinpathrequired
userland_user_organization_memberships_controller_list
- Operation ID:
userland_user_organization_memberships_controller_list - Route:
GET /user_management/organization_memberships - Mode: READ
- Summary: List organization memberships
- Parameters:
beforeinqueryafterinquerylimitinqueryorderinqueryorganization_idinquerystatusesinqueryuser_idinquery
userland_user_organization_memberships_controller_create
- Operation ID:
userland_user_organization_memberships_controller_create - Route:
POST /user_management/organization_memberships - Mode: WRITE
- Summary: Create an organization membership
- Body: JSON request body accepted.
userland_user_organization_memberships_controller_get
- Operation ID:
userland_user_organization_memberships_controller_get - Route:
GET /user_management/organization_memberships/{id} - Mode: READ
- Summary: Get an organization membership
- Parameters:
idinpathrequired
userland_user_organization_memberships_controller_delete
- Operation ID:
userland_user_organization_memberships_controller_delete - Route:
DELETE /user_management/organization_memberships/{id} - Mode: WRITE
- Summary: Delete an organization membership
- Parameters:
idinpathrequired
userland_user_organization_memberships_controller_update
- Operation ID:
userland_user_organization_memberships_controller_update - Route:
PUT /user_management/organization_memberships/{id} - Mode: WRITE
- Summary: Update an organization membership
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
userland_user_organization_memberships_controller_deactivate
- Operation ID:
userland_user_organization_memberships_controller_deactivate - Route:
PUT /user_management/organization_memberships/{id}/deactivate - Mode: WRITE
- Summary: Deactivate an organization membership
- Parameters:
idinpathrequired
userland_user_organization_memberships_controller_reactivate
- Operation ID:
userland_user_organization_memberships_controller_reactivate - Route:
PUT /user_management/organization_memberships/{id}/reactivate - Mode: WRITE
- Summary: Reactivate an organization membership
- Parameters:
idinpathrequired
organization_membership_groups_controller_list_groups
- Operation ID:
organization_membership_groups_controller_list_groups - Route:
GET /user_management/organization_memberships/{omId}/groups - Mode: READ
- Summary: List groups
- Parameters:
omIdinpathrequiredbeforeinqueryafterinquerylimitinqueryorderinquery
userland_users_controller_create_password_reset_token
- Operation ID:
userland_users_controller_create_password_reset_token - Route:
POST /user_management/password_reset - Mode: WRITE
- Summary: Create a password reset token
- Body: JSON request body accepted.
userland_users_controller_reset_password_0
- Operation ID:
userland_users_controller_reset_password_0 - Route:
POST /user_management/password_reset/confirm - Mode: WRITE
- Summary: Reset the password
- Body: JSON request body accepted.
userland_users_controller_get_password_reset
- Operation ID:
userland_users_controller_get_password_reset - Route:
GET /user_management/password_reset/{id} - Mode: READ
- Summary: Get a password reset token
- Parameters:
idinpathrequired
redirect_uris_controller_create
- Operation ID:
redirect_uris_controller_create - Route:
POST /user_management/redirect_uris - Mode: WRITE
- Summary: Create a redirect URI
- Body: JSON request body accepted.
userland_sessions_controller_logout
- Operation ID:
userland_sessions_controller_logout - Route:
GET /user_management/sessions/logout - Mode: READ
- Summary: Logout
- Parameters:
session_idinqueryrequiredreturn_toinquery
userland_sessions_controller_revoke_session
- Operation ID:
userland_sessions_controller_revoke_session - Route:
POST /user_management/sessions/revoke - Mode: WRITE
- Summary: Revoke Session
- Body: JSON request body accepted.
userland_users_controller_list_0
- Operation ID:
userland_users_controller_list_0 - Route:
GET /user_management/users - Mode: READ
- Summary: List users
- Parameters:
beforeinqueryafterinquerylimitinqueryorderinqueryorganizationinqueryorganization_idinqueryemailinquery
userland_users_controller_create_0
- Operation ID:
userland_users_controller_create_0 - Route:
POST /user_management/users - Mode: WRITE
- Summary: Create a user
- Body: JSON request body accepted.
userland_users_controller_get_by_external_id
- Operation ID:
userland_users_controller_get_by_external_id - Route:
GET /user_management/users/external_id/{external_id} - Mode: READ
- Summary: Get a user by external ID
- Parameters:
external_idinpathrequired
userland_users_controller_update_0
- Operation ID:
userland_users_controller_update_0 - Route:
PUT /user_management/users/{id} - Mode: WRITE
- Summary: Update a user
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
userland_users_controller_get_0
- Operation ID:
userland_users_controller_get_0 - Route:
GET /user_management/users/{id} - Mode: READ
- Summary: Get a user
- Parameters:
idinpathrequired
userland_users_controller_delete_0
- Operation ID:
userland_users_controller_delete_0 - Route:
DELETE /user_management/users/{id} - Mode: WRITE
- Summary: Delete a user
- Parameters:
idinpathrequired
userland_users_controller_confirm_email_change
- Operation ID:
userland_users_controller_confirm_email_change - Route:
POST /user_management/users/{id}/email_change/confirm - Mode: WRITE
- Summary: Confirm email change
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
userland_users_controller_send_email_change
- Operation ID:
userland_users_controller_send_email_change - Route:
POST /user_management/users/{id}/email_change/send - Mode: WRITE
- Summary: Send email change code
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
userland_users_controller_email_verification_0
- Operation ID:
userland_users_controller_email_verification_0 - Route:
POST /user_management/users/{id}/email_verification/confirm - Mode: WRITE
- Summary: Verify email
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
userland_users_controller_send_verification_email_0
- Operation ID:
userland_users_controller_send_verification_email_0 - Route:
POST /user_management/users/{id}/email_verification/send - Mode: WRITE
- Summary: Send verification email
- Parameters:
idinpathrequired
userland_user_identities_controller_get
- Operation ID:
userland_user_identities_controller_get - Route:
GET /user_management/users/{id}/identities - Mode: READ
- Summary: Get user identities
- Parameters:
idinpathrequired
userland_user_sessions_controller_list
- Operation ID:
userland_user_sessions_controller_list - Route:
GET /user_management/users/{id}/sessions - Mode: READ
- Summary: List sessions
- Parameters:
idinpathrequiredbeforeinqueryafterinquerylimitinqueryorderinquery
user_api_keys_controller_list
- Operation ID:
user_api_keys_controller_list - Route:
GET /user_management/users/{userId}/api_keys - Mode: READ
- Summary: List API keys for a user
- Parameters:
userIdinpathrequiredbeforeinqueryafterinquerylimitinqueryorderinqueryorganization_idinquery
user_api_keys_controller_create
- Operation ID:
user_api_keys_controller_create - Route:
POST /user_management/users/{userId}/api_keys - Mode: WRITE
- Summary: Create an API key for a user
- Parameters:
userIdinpathrequired
- Body: JSON request body accepted.
userland_user_feature_flags_controller_list
- Operation ID:
userland_user_feature_flags_controller_list - Route:
GET /user_management/users/{userId}/feature-flags - Mode: READ
- Summary: List enabled feature flags for a user
- Parameters:
userIdinpathrequiredbeforeinqueryafterinquerylimitinqueryorderinquery
authorized_applications_controller_list
- Operation ID:
authorized_applications_controller_list - Route:
GET /user_management/users/{user_id}/authorized_applications - Mode: READ
- Summary: List authorized applications
- Parameters:
user_idinpathrequiredbeforeinqueryafterinquerylimitinqueryorderinquery
authorized_applications_controller_delete
- Operation ID:
authorized_applications_controller_delete - Route:
DELETE /user_management/users/{user_id}/authorized_applications/{application_id} - Mode: WRITE
- Summary: Delete an authorized application
- Parameters:
application_idinpathrequireduser_idinpathrequired
data_integrations_user_management_controller_get_user_data_installation
- Operation ID:
data_integrations_user_management_controller_get_user_data_installation - Route:
GET /user_management/users/{user_id}/connected_accounts/{slug} - Mode: READ
- Summary: Get a connected account
- Parameters:
user_idinpathrequiredsluginpathrequiredorganization_idinquery
data_integrations_user_management_controller_delete_user_data_installation
- Operation ID:
data_integrations_user_management_controller_delete_user_data_installation - Route:
DELETE /user_management/users/{user_id}/connected_accounts/{slug} - Mode: WRITE
- Summary: Delete a connected account
- Parameters:
user_idinpathrequiredsluginpathrequiredorganization_idinquery
data_integrations_user_management_controller_get_user_data_integrations
- Operation ID:
data_integrations_user_management_controller_get_user_data_integrations - Route:
GET /user_management/users/{user_id}/data_providers - Mode: READ
- Summary: List providers for a user
- Parameters:
user_idinpathrequiredorganization_idinquery
userland_user_authentication_factors_controller_create_0
- Operation ID:
userland_user_authentication_factors_controller_create_0 - Route:
POST /user_management/users/{userlandUserId}/auth_factors - Mode: WRITE
- Summary: Enroll an authentication factor
- Parameters:
userlandUserIdinpathrequired
- Body: JSON request body accepted.
userland_user_authentication_factors_controller_list_0
- Operation ID:
userland_user_authentication_factors_controller_list_0 - Route:
GET /user_management/users/{userlandUserId}/auth_factors - Mode: READ
- Summary: List authentication factors
- Parameters:
userlandUserIdinpathrequiredbeforeinqueryafterinquerylimitinqueryorderinquery