client.users.patch_me

A method of the Users endpoint.

patch_me(*, preferences: dict = None, last_checked_announcements: str = None) → Response

Update info about the logged-in user

API URL: PATCH /users/me

import civis
client = civis.APIClient()
response = client.users.patch_me(...)

Parameters:

preferencesdict, optional

• app_index_order_fieldstr

  This attribute is deprecated

• app_index_order_dirstr

  This attribute is deprecated

• result_index_order_fieldstr

  Order field for the reports index page.

• result_index_order_dirstr

  Order direction for the reports index page.

• result_index_type_filterstr

  Type filter for the reports index page.

• result_index_author_filterstr

  Author filter for the reports index page.

• result_index_archived_filterstr

  Archived filter for the reports index page.

• import_index_order_fieldstr

  Order field for the imports index page.

• import_index_order_dirstr

  Order direction for the imports index page.

• import_index_type_filterstr

  Type filter for the imports index page.

• import_index_author_filterstr

  Author filter for the imports index page.

• import_index_dest_filterstr

  Destination filter for the imports index page.

• import_index_status_filterstr

  Status filter for the imports index page.

• import_index_archived_filterstr

  Archived filter for the imports index page.

• export_index_order_fieldstr

  Order field for the exports index page.

• export_index_order_dirstr

  Order direction for the exports index page.

• export_index_type_filterstr

  Type filter for the exports index page.

• export_index_author_filterstr

  Author filter for the exports index page.

• export_index_status_filterstr

  Status filter for the exports index page.

• model_index_order_fieldstr

  Order field for the models index page.

• model_index_order_dirstr

  Order direction for the models index page.

• model_index_author_filterstr

  Author filter for the models index page.

• model_index_status_filterstr

  Status filter for the models index page.

• model_index_archived_filterstr

  Archived filter for the models index page.

• model_index_thumbnail_viewstr

  Thumbnail view for the models index page.

• script_index_order_fieldstr

  Order field for the scripts index page.

• script_index_order_dirstr

  Order direction for the scripts index page.

• script_index_type_filterstr

  Type filter for the scripts index page.

• script_index_author_filterstr

  Author filter for the scripts index page.

• script_index_status_filterstr

  Status filter for the scripts index page.

• script_index_archived_filterstr

  Archived filter for the scripts index page.

• project_index_order_fieldstr

  Order field for the projects index page.

• project_index_order_dirstr

  Order direction for the projects index page.

• project_index_author_filterstr

  Author filter for the projects index page.

• project_index_archived_filterstr

  Archived filter for the projects index page.

• report_index_thumbnail_viewstr

  Thumbnail view for the reports index page.

• project_detail_order_fieldstr

  Order field for projects detail pages.

• project_detail_order_dirstr

  Order direction for projects detail pages.

• project_detail_author_filterstr

  Author filter for projects detail pages.

• project_detail_type_filterstr

  Type filter for projects detail pages.

• project_detail_archived_filterstr

  Archived filter for the projects detail pages.

• enhancement_index_order_fieldstr

  Order field for the enhancements index page.

• enhancement_index_order_dirstr

  Order direction for the enhancements index page.

• enhancement_index_author_filterstr

  Author filter for the enhancements index page.

• enhancement_index_archived_filterstr

  Archived filter for the enhancements index page.

• preferred_server_idint

  ID of preferred server.

• civis_explore_skip_introbool

  Whether the user is shown steps for each exploration.

• registration_index_order_fieldstr

  Order field for the registrations index page.

• registration_index_order_dirstr

  Order direction for the registrations index page.

• registration_index_status_filterstr

  Status filter for the registrations index page.

• upgrade_requestedstr

  Whether a free trial upgrade has been requested.

• welcome_order_fieldstr

  Order direction for the welcome page.

• welcome_order_dirstr

  Order direction for the welcome page.

• welcome_author_filterstr

  Status filter for the welcome page.

• welcome_status_filterstr

  Status filter for the welcome page.

• welcome_archived_filterstr

  Status filter for the welcome page.

• data_pane_widthstr

  Width of the data pane when expanded.

• data_pane_collapsedstr

  Whether the data pane is collapsed.

• notebook_order_fieldstr

  Order field for the notebooks page.

• notebook_order_dirstr

  Order direction for the notebooks page.

• notebook_author_filterstr

  Author filter for the notebooks page.

• notebook_archived_filterstr

  Archived filter for the notebooks page.

• notebook_status_filterstr

  Status filter for the notebooks page.

• workflow_index_order_fieldstr

  Order field for the workflows page.

• workflow_index_order_dirstr

  Order direction for the workflows page.

• workflow_index_author_filterstr

  Author filter for the workflows page.

• workflow_index_archived_filterstr

  Archived filter for the workflows page.

• service_order_fieldstr

  Order field for the services page.

• service_order_dirstr

  Order direction for the services page.

• service_author_filterstr

  Author filter for the services page.

• service_archived_filterstr

  Archived filter for the services page.

• assume_role_historystr

  JSON string of previously assumed roles.

• default_success_notifications_onbool

  Whether email notifications for the success of all applicable jobs are on by default.

• default_failure_notifications_onbool

  Whether email notifications for the failure of all applicable jobs are on by default.

• my_activity_metricsbool

  Whether the activity metrics are filtered to the current user.

• standard_sql_autocomplete_disabledbool

  Whether the query page includes standard SQL autocomplete.

• ai_sql_assist_disabledbool

  Whether the query page includes AI-powered SQL autocomplete.

• query_preview_rowsint

  Number of preview rows query should return in the UI.

last_checked_announcementsstr (date-time), optional

The date and time at which the user last checked their announcements.

Returns:

civis.Response

• idint

  The ID of this user.

• namestr

  This user’s name.

• emailstr

  This user’s email address.

• usernamestr

  This user’s username.

• initialsstr

  This user’s initials.

• last_checked_announcementsstr (date-time)

  The date and time at which the user last checked their announcements.

• feature_flagscivis.Response

  The feature flag settings for this user.

• rolesList[str]

  The roles this user has, listed by slug.

• preferencescivis.Response

  This user’s preferences.

• custom_brandingstr

  The branding of Platform for this user.

• primary_group_idint

  The ID of the primary group of this user.

• groupsList[civis.Response]

  An array of all the groups this user is in.

  • idint

    The ID of this group.

  • namestr

    The name of this group.

  • slugstr

    The slug of this group.

  • organization_idint

    The ID of the organization associated with this group.

  • organization_namestr

    The name of the organization associated with this group.

• organization_namestr

  The name of the organization the user belongs to.

• organization_slugstr

  The slug of the organization the user belongs to.

• organization_default_theme_idint

  The ID of the organizations’s default theme.

• created_atstr (date-time)

  The date and time when the user was created.

• sign_in_countint

  The number of times the user has signed in.

• assuming_rolebool

  Whether the user is assuming this role or not.

• role_assumercivis.Response

  Details about the role assumer.

• assuming_adminbool

  Whether the user is assuming admin.

• assuming_admin_expirationstr (date-time)

  When the user’s admin role is set to expire.

• superadmin_mode_expirationstr (date-time)

  The user is in superadmin mode when set to a DateTime. The user is not in superadmin mode when set to null.

• disable_non_compliant_fedramp_featuresbool

  Whether to disable non-compliant fedramp features.

• persona_rolestr

  The high-level role representing the current user’s main permissions.

• created_by_idint

  The ID of the user who created this user.

• last_updated_by_idint

  The ID of the user who last updated this user.