Skip to main content

Module user_api

Module user_api 

Source

Enums§

AcceptInviteError
struct for typed errors of method accept_invite
ConvertUserToGroupError
struct for typed errors of method convert_user_to_group
CreateLspTokenError
struct for typed errors of method create_lsp_token
CreateTokenError
struct for typed errors of method create_token
CreateTokenImpersonateError
struct for typed errors of method create_token_impersonate
CreateUserGloballyError
struct for typed errors of method create_user_globally
DeclineInviteError
struct for typed errors of method decline_invite
DeleteTokenError
struct for typed errors of method delete_token
DeleteUserError
struct for typed errors of method delete_user
ExistsEmailError
struct for typed errors of method exists_email
ExitImpersonationError
struct for typed errors of method exit_impersonation
GetCurrentEmailError
struct for typed errors of method get_current_email
GetRunnableError
struct for typed errors of method get_runnable
GetTutorialProgressError
struct for typed errors of method get_tutorial_progress
GetUsageError
struct for typed errors of method get_usage
GetUserError
struct for typed errors of method get_user
GetUserSeatsError
struct for typed errors of method get_user_seats
GlobalOffboardPreviewError
struct for typed errors of method global_offboard_preview
GlobalUserDeleteError
struct for typed errors of method global_user_delete
GlobalUserRenameError
struct for typed errors of method global_user_rename
GlobalUserUpdateError
struct for typed errors of method global_user_update
GlobalUsernameInfoError
struct for typed errors of method global_username_info
GlobalUsersExportError
struct for typed errors of method global_users_export
GlobalUsersOverwriteError
struct for typed errors of method global_users_overwrite
GlobalWhoamiError
struct for typed errors of method global_whoami
ImpersonateServiceAccountError
struct for typed errors of method impersonate_service_account
IsOwnerOfPathError
struct for typed errors of method is_owner_of_path
IsPasswordLoginDisabledError
struct for typed errors of method is_password_login_disabled
IsSmtpConfiguredError
struct for typed errors of method is_smtp_configured
LeaveInstanceError
struct for typed errors of method leave_instance
ListExtJwtTokensError
struct for typed errors of method list_ext_jwt_tokens
ListTokensError
struct for typed errors of method list_tokens
ListUsernamesError
struct for typed errors of method list_usernames
ListUsersAsSuperAdminError
struct for typed errors of method list_users_as_super_admin
ListUsersError
struct for typed errors of method list_users
ListUsersUsageError
struct for typed errors of method list_users_usage
ListWorkspaceInvitesError
struct for typed errors of method list_workspace_invites
LoginError
struct for typed errors of method login
LoginWithOauthError
struct for typed errors of method login_with_oauth
LogoutError
struct for typed errors of method logout
OffboardGlobalUserError
struct for typed errors of method offboard_global_user
OffboardPreviewError
struct for typed errors of method offboard_preview
OffboardWorkspaceUserError
struct for typed errors of method offboard_workspace_user
RefreshUserTokenError
struct for typed errors of method refresh_user_token
RequestPasswordResetError
struct for typed errors of method request_password_reset
ResetPasswordError
struct for typed errors of method reset_password
SetLoginTypeForUserError
struct for typed errors of method set_login_type_for_user
SetPasswordError
struct for typed errors of method set_password
SetPasswordForUserError
struct for typed errors of method set_password_for_user
SubmitOnboardingDataError
struct for typed errors of method submit_onboarding_data
UpdateTokenScopesError
struct for typed errors of method update_token_scopes
UpdateTutorialProgressError
struct for typed errors of method update_tutorial_progress
UpdateUserError
struct for typed errors of method update_user
UsernameToEmailError
struct for typed errors of method username_to_email
WhoamiError
struct for typed errors of method whoami
WhoisError
struct for typed errors of method whois

Functions§

accept_invite
convert_user_to_group
create_lsp_token
Mints the browser’s LSP token server-side. Separate from /users/tokens/create because the label it carries is reserved: a user must not be able to mint a token that audits as the lsp synthetic actor, but the editor legitimately needs one. The label and expiry are constants on the server, so this takes no body at all.
create_token
create_token_impersonate
create_user_globally
decline_invite
delete_token
delete_user
exists_email
exit_impersonation
Restores the browser session the client held before impersonating a service account. Authenticated by the session cookie alone: a request carrying an Authorization header or a ?token= query parameter is refused. The cookie must be a live browser session of the impersonated service account; it is revoked on success.
get_current_email
get_runnable
get_tutorial_progress
get_usage
get_user
get_user_seats
global_offboard_preview
global_user_delete
global_user_rename
global_user_update
global_username_info
global_users_export
global_users_overwrite
global_whoami
impersonate_service_account
is_owner_of_path
is_password_login_disabled
is_smtp_configured
leave_instance
list_ext_jwt_tokens
list_tokens
list_usernames
list_users
list_users_as_super_admin
list_users_usage
list_workspace_invites
login
login_with_oauth
logout
offboard_global_user
offboard_preview
offboard_workspace_user
refresh_user_token
request_password_reset
reset_password
set_login_type_for_user
set_password
set_password_for_user
submit_onboarding_data
update_token_scopes
update_tutorial_progress
update_user
username_to_email
whoami
whois