{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"usermenu","__idx":0},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userMenu"]}]},{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"products":["Redoc","Revel","Reef","Realm"],"plans":["Pro","Enterprise","Enterprise+"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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 to display a dropdown menu."," ","The menu contains the avatar, the user's email address, links to pages you can configure, and a log out option."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/user-menu-31957bdc2fa4c2a5.png","alt":"Screenshot of the user menu with the dropdown displayed","framed":true,"withLightbox":true},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Required configuration"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You must also have ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sso"]}," and either ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rbac"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requiresLogin"]}," configured for the userMenu to display."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"options","__idx":1},"children":["Options"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hide"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies if the User menu should be hidden."," ","Only required if you do not add any other options to the configuration."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hideLoginButton"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies if the login button that displays in the far right side of the navbar should be hidden."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["items"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#item-object"},"children":["Item"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of links in the User menu dropdown."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"item-object","__idx":2},"children":["Item object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["page"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CONDITIONALLY REQUIRED."]}," ","Relative or absolute path to the file (extension included), or a full route slug which represents the page to link to."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Mutually exclusive"]}," with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["href"]}," option."," ","If you don't include a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]}," option, the link text matches the level 1 heading of the page."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Examples"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["./index.md"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/docs/tutorial.md"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["../../glossary.md"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/info#admonition"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["./test.md#rename"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["href"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CONDITIONALLY REQUIRED."]}," ","URL to link to."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Mutually exclusive"]}," with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," option."," ","If you don't include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]}," option, the link text matches the value of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["href"]},"."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Examples"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://redocly.com"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://www.openapis.org/"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["label"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Link text displayed for the item."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["labelTranslationKey"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Link text key for the item used for ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/l10n"},"children":["localization"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["external"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Open link in new browser tab."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":3},"children":["Examples"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"userMenu:\n  hide: false\n  hideLoginButton: true\n  items:\n    - href: /my-settings/\n      label: Settings\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":4},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/access"},"children":["Control site access"]}]}," - Configure role-based access control to manage user permissions and access levels for user menu functionality"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/reunite/organization/sso/configure-sso"},"children":["Configure project SSO"]}]}," - Set up single sign-on integration to enable seamless user authentication and menu personalization"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/access/rbac"},"children":["Role-based access control"]}]}," - Understand how role-based access control works in Redocly products for comprehensive user menu and permission management"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/navbar"},"children":["Navbar configuration"]}]}," - Add additional links to the navbar and configure navbar appearance to complement the user menu"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/access/sso"},"children":["SSO configuration"]}]}," - Configure SSO authentication required for user menu display and functionality"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/access/rbac"},"children":["RBAC configuration"]}]}," - Set up role-based access control as an alternative to requiresLogin for user menu access management"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/access/requires-login"},"children":["Requires login configuration"]}]}," - Configure login requirements as an alternative to RBAC for enabling user menu functionality"]}]}]},"frontmatter":{"products":["Redoc","Revel","Reef","Realm"],"plans":["Pro","Enterprise","Enterprise+"],"description":"Set the visibility of the user menu in your project."},"tagList":["admonition","configOptionRequirements","img","table"],"title":"userMenu","lastModified":"2026-10-01T23:00:57.000Z"}