Skip to content
Last updated

userMenu

Products:RedocRedocRevelRevelReefReefRealmRealm
Plans:ProEnterpriseEnterprise+

Set the visibility of the user menu in your project. The user menu is displayed in the far right side of the navbar. Users can click the user avatar and a dropdown menu displays with the avatar, the user's email address, links to pages you can configure, and a log out option.

Screenshot of the user menu with the dropdown displayed
Required configuration

You must also have sso and either rbac or requiresLogin configured for the userMenu to display.

Options

OptionTypeDescription
hidebooleanSpecifies if the User menu should be hidden. Only required if you do not add any other options to the configuration. Default: false.
hideLoginButtonbooleanSpecifies if the login button that displays in the far right side of the navbar should be hidden. Default: false.
itemsItemList of links in the User menu dropdown.

Item object

OptionTypeDescription
pagestringCONDITIONALLY REQUIRED. Relative or absolute path to the file (extension included), or a full route slug which represents the page to link to. Mutually exclusive with the href option. If you don't include a label option, the link text matches the level 1 heading of the page. Examples: ./index.md, /docs/tutorial.md, ../../glossary.md, /info#admonition, ./test.md#rename.
hrefstringCONDITIONALLY REQUIRED. URL to link to. Mutually exclusive with the page option. If you don't include the label option, the link text matches the value of href. Examples: https://redocly.com, https://www.openapis.org/.
labelstringLink text displayed for the item.
labelTranslationKeystringLink text key for the item used for localization.
externalbooleanOpen link in new browser tab. Default is false.

Examples

userMenu:
  hide: false
  hideLoginButton: true
  items:
    - href: /my-settings/
      label: Settings

Resources

  • Configure RBAC - Configure role-based access control to manage user permissions and access levels for user menu functionality
  • Configure SSO - Set up single sign-on integration to enable seamless user authentication and menu personalization
  • RBAC concepts - Understand how role-based access control works in Redocly products for comprehensive user menu and permission management
  • Navbar configuration - Add additional links to the navbar and configure navbar appearance to complement the user menu
  • SSO configuration - Configure SSO authentication required for user menu display and functionality
  • RBAC configuration - Set up role-based access control as an alternative to requiresLogin for user menu access management
  • Requires login configuration - Configure login requirements as an alternative to RBAC for enabling user menu functionality

versionPicker