Skip to content

Configuration Settings

Michael Johnson edited this page Feb 27, 2023 · 2 revisions

Configuration Settings

Following are all the configuration properties and default settings used in this plugin along with an explanation of the property, and the default value.

Note: All property keys begin with sonar.auth.aad. For brevity, only the portion after this prefix is in the tables below.

Authentication Properties

Key Name Description Type Default
enabled Enabled Enables/disables the plugin. This setting is ignored if Client ID and Secret are not set. boolean false
clientId.secured Client ID The Application/Client ID from the Azure Portal. string None
clientSecret.secured Client Secret The Key for the Application from the Azure Portal. string None
multiTenant Multi-tenant Azure Application Allow login from all AAD/Microsoft Accounts, even outside your org. Normally you do not want this enabled. boolean false
tenantId Azure AD Tenant ID The "Directory ID" from the Azure Portal. Optional if multi-tenant is enabled. string None
allowUsersToSignUp Allow users to sign-up Allows new users (to SonarQube) to authenticate. If false, only accounts that already exist on SonarQube will be allowed to log in. boolean true
loginStrategy Login generation strategy (Plugin v1 only) Only valid for SonarQube before 8.0. When set to Unique, generates a unique username on the first login. When set to Same as Azure AD login, will use the login name (usually an e-mail address). Select List Unique
directoryLocation Directory Location The "location" for the Azure directory. Useful for authenticating against the various national clouds. Select List Azure AD (Global)

Group Sync Properties

Key Name Description Type Default
enableGroupsSync Enable Groups Sync Sync Group Membership from Azure to SonarQube. boolean false
enableClientCredential Use Client Credentials Sync Method (Plugin v2) Sync with the application's own access instead of the user's boolean false