Skip to content

armgit / zulip

Public Imported from GitHub
0

Zulip server and web application. Open-source team chat that helps teams stay productive and focused.

7.1 KB
Raw Blame
---
title: Custom profile fields
---

import FlattenedSteps from "../../components/FlattenedSteps.astro";
import NavigationSteps from "../../components/NavigationSteps.astro";
import ZulipTip from "../../components/ZulipTip.astro";
import AdminOnly from "../include/_AdminOnly.mdx";

import EditIcon from "~icons/zulip-icon/edit";
import TrashIcon from "~icons/zulip-icon/trash";

<AdminOnly />

[User cards](/help/user-cards) show basic information about a user, and [user
profiles](/help/view-someones-profile) provide additional details. You can add
custom profile fields to user cards and user profiles, making it easy for users
to share information, such as their pronouns, job title, or team.

Zulip supports many types of profile fields, such as dates, lists of options,
account links, and [more](#profile-field-types). You can choose which
custom profile fields to [display](#display-custom-fields-on-user-card) on user
cards. Custom profile fields can be optional or
[required](#make-a-custom-profile-field-required).

You can [configure](#use-a-custom-profile-field-in--mention-suggestions)
**External account** and **Short text** custom profile fields to be used for
[@-mention](/help/mention-a-user-or-group) suggestions. For example, users could
be mentioned by their GitHub or Mastodon usernames.

Zulip supports synchronizing custom profile fields from an external
user database such as LDAP or SAML. See the [authentication
methods][authentication-production] documentation for details.

## Add a custom profile field

<FlattenedSteps>
  <NavigationSteps target="settings/profile-field-settings" />

  1. Click **Add a new profile field**.
  1. Fill out profile field information as desired, and click **Add**.
  1. In the **Labels** column, click and drag the vertical dots to reorder the
     list of custom profile fields.
</FlattenedSteps>

## Edit a custom profile field

<FlattenedSteps>
  <NavigationSteps target="settings/profile-field-settings" />

  1. In the **Actions** column, click the **edit** (<EditIcon />)
     icon for the profile field you want to edit.
  1. Edit profile field information as desired, and click **Save changes**.
</FlattenedSteps>

## Delete a custom profile field

<FlattenedSteps>
  <NavigationSteps target="settings/profile-field-settings" />

  1. In the **Actions** column, click the **delete** (<TrashIcon />) icon for the profile field you want to delete.
  1. Approve by clicking **Confirm**.
</FlattenedSteps>

## Reorder custom profile fields

Users will see custom profile fields in the specified order.

<FlattenedSteps>
  <NavigationSteps target="settings/profile-field-settings" />

  1. In the **Labels** column, click and drag the vertical dots to reorder the
     list of custom profile fields.
</FlattenedSteps>

## Display custom fields on user card

Organizations may find it useful to display additional fields on the
user card, such as pronouns, GitHub username, job title, team, etc.

All field types other than "Person" have a checkbox option
that controls whether to display a custom field on the user card.
There's a limit to the number of custom profile fields that can be displayed
at a time. If the maximum number of fields is already selected, all unselected
checkboxes will be disabled.

<FlattenedSteps>
  <NavigationSteps target="settings/profile-field-settings" />

  1. In the **Actions** column, click the **edit** (<EditIcon />)
     icon for the profile field you want to edit.
  1. Toggle **Display on user card**.
  1. Click **Save changes**.
</FlattenedSteps>

<ZulipTip>
  You can also choose which custom profile fields will be displayed by toggling
  the checkboxes in the **Card** column of the **Custom profile fields** table.
</ZulipTip>

## Make a custom profile field required

If a custom profile field is required, users who have left it blank will see a
banner every time they open the Zulip web or desktop app prompting them to fill
it out.

<FlattenedSteps>
  <NavigationSteps target="settings/profile-field-settings" />

  1. In the **Actions** column, click the **edit** (<EditIcon />)
     icon for the profile field you want to edit.
  1. Toggle **Required field**.
  1. Click **Save changes**.
</FlattenedSteps>

<ZulipTip>
  You can also choose which custom profile fields are required by toggling the
  checkboxes in the **Required** column of the **Custom profile fields** table.
</ZulipTip>

## Use a custom profile field in @-mention suggestions

**External account** and **Short text** custom profile fields can be used for
[@-mention](/help/mention-a-user-or-group) suggestions.

<FlattenedSteps>
  <NavigationSteps target="settings/profile-field-settings" />

  1. In the **Actions** column, click the **edit** (<EditIcon />)
     icon for the profile field you want to edit.
  1. Toggle **Use in @-mention suggestions**.
  1. Click **Save changes**.
</FlattenedSteps>

## Configure whether users can edit custom profile fields

You can configure whether users in your organization can edit custom profile
fields for their own account. For example, you may want to restrict editing if
syncing profile fields from an employee directory.

<FlattenedSteps>
  <NavigationSteps target="settings/profile-field-settings" />

  1. In the **Actions** column, click the **edit** (<EditIcon />)
     icon for the profile field you want to configure.
  1. Toggle **Users can edit this field for their own account**.
  1. Click **Save changes**.
</FlattenedSteps>

## Profile field types

Choose the profile field type that's most appropriate for the requested information.

* **Date**: For dates (e.g., birthdays or work anniversaries).
* **Link**: For links to websites, including company-internal pages.
* **External account**: For linking to an external account (e.g., GitHub,
  GitLab, LinkedIn, etc.). You can
  [configure](#use-a-custom-profile-field-in--mention-suggestions) this field to
  be used for [@-mention](/help/mention-a-user-or-group) suggestions. Some
  integrations ([Bitbucket](/integrations/bitbucket),
  [GitHub](/integrations/github), [GitLab](/integrations/gitlab),
  [Jira](/integrations/jira)) use [silent
  mentions](/help/mention-a-user-or-group#silently-mention-a-user) to refer to
  users if a matching external account is configured.
* **Dropdown**: A dropdown with a list of predefined options (e.g.,
  office location).
* **Pronouns**: What pronouns should people use to refer to the user? Pronouns
  are displayed in [user mention](/help/mention-a-user-or-group) autocomplete
  suggestions.
* **Paragraph**: For multiline responses (e.g., a user's intro message).
* **Short text**: For one-line responses up to 50 characters (e.g., team name or
  role in your organization). You can
  [configure](#use-a-custom-profile-field-in--mention-suggestions) this field to
  be used for [@-mention](/help/mention-a-user-or-group) suggestions.
* **Users**: For selecting one or more users (e.g., manager or direct reports).

## Related articles

* [Edit your profile](/help/edit-your-profile)
* [User cards](/help/user-cards)
* [View someone's profile](/help/view-someones-profile)

[authentication-production]: https://zulip.readthedocs.io/en/stable/production/authentication-methods.html