- Overview
- Configuration
SonarCloud
Streamline user lifecycle management in SonarCloud with ADManager Plus
SonarCloud is a cloud-based code analysis service designed to catch bugs and security vulnerabilities in code repositories. Integrating SonarCloud with ManageEngine ADManager Plus allows organizations to optimize user lifecycle management within development environments. This integration automates the provisioning and de-provisioning of user accounts, ensuring appropriate access levels for users. This helps HR, IT, and development teams improve collaboration and streamline user lifecycle management.
Simplify user onboarding
Automatically initiate user creation for new developers, providing them with the necessary access to SonarCloud for code quality and security analysis.
Enforce secure offboarding
Disable or delete SonarCloud accounts for departing employees to prevent unauthorized access to code repositories and project data.
Marketplace document: ADManager Plus - SonarCloud integration
Prerequisites:
Requires API Key and API Token to authorize API requests
Privileges:
- To import users (Inbound action): Ensure the account used for authorization has permission to read all user accounts.
- To perform any action or query in SonarCloud (Outbound Action): Ensure the account used for authorization has permission to perform the desired action.
Authorization configuration
- Log in to ADManager Plus> and navigate to the Automation tab.
- In the left pane, under Configuration, click Application Integrations.
- Under Enterprise Applications, click SonarCloud.
- Toggle the Enable SonarCloud Integration button on.
- Click Configure.
Inbound webhook configuration
Inbound webhook enables you to fetch user data from SonarCloud to ADManager Plus. The attribute mapping configured in this section can be selected as the data source during automation configuration to perform the desired action on the list of users received from the API response.
To configure an inbound webhook for SonarCloud:
- Under Inbound Webhook, click SonarCloud Endpoint Configuration.
- In the Endpoint Configuration tab, an endpoint, SonarCloud USERS ENDPOINT, comes preconfigured with an Endpoint URL, API Method, Headers, and Parameters fields to fetch user accounts from SonarCloud. If you would like to use this pre-configured endpoint, replace {API Key} with the API Key and API Token, of your SonarCloud instance in the Endpoint URL field. However, if you would like to use a new endpoint to import users, you can configure one using the + Add API endpoint button and filling in the required fields as per SonarCloud's API references. Click here to learn how.
- The API key value pair is pre-configured as a header for authenticating API requests as configured during Authorization Configuration.
- Macros: You can add macros to your endpoint configuration to dynamically change it as per your requirement using the macro chooser component.
- Refer to SonarCloud's API references and configure additional headers and parameters, if required.
- Once done, click Test & Save. A response window will display all the requested parameters that can be fetched using the API call. Click Proceed.
- Refer to SonarCloud's API references to see which Parameters that must be configured to fetch only specific parameters.
- You can configure multiple endpoints for SonarCloud using the + Add API endpoint button. Click here to learn how.
- Click Data Source - LDAP Attribute Mapping to match endpoints and to map AD LDAP attributes with the respective attributes in SonarCloud. [ADManager Plus also lets you customize attribute format from SonarCloud]
- Click + Add New Configuration and perform the following:
- Enter the Configuration Name and Description and select the Automation Category from the drop-down menu.
- In the Select Endpoint field, select the desired endpoint and a Primary Key that is unique to a user (e.g. employeeIdentifier). Note: When multiple endpoints are configured, this attribute must hold the same value in all the endpoints.
- In the Attribute Mapping field, select the attribute from the LDAP Attribute Name drop-down menu and map it with the respective column in SonarCloud.
- If you would like to create a new custom format for this, click Mapping Attribute.
- Click Save.
Note:
Note:
Outbound webhook configuration
Outbound webhooks enable you to send changes made in AD to SonarCloud, fetch data from SonarCloud, and carry out tasks in SonarCloud—all from ADManager Plus. The webhooks configured in this section can be included in Orchestration Templates, which in turn can be used during event-driven and scheduled automations. They can also be applied directly on desired users to perform a sequence of actions on them (Management > Advanced Management > Orchestration).
To configure outbound webhooks for SonarCloud:
- Under Outbound Webhook, click SonarCloud Webhook Configuration.
- Click + Add Webhook.
- Enter a name and description for this webhook.
- Decide on the action that has to be performed and refer to SonarCloud's API references for the API details such as URL, and the headers, parameters, and other requirements that will be needed.
- Select the HTTP method that will enable you to perform the desired action on the endpoint from the drop-down menu.
- Enter the endpoint URL.
- Configure the Headers, Parameters, and Message Type in the appropriate format based on the API call that you would like to perform.
- Click Test and Save.
- A pop-up window will then display a list of AD users and groups to test the configured API call. Select the desired user or group for which this API request has to be tested and click OK. This will make a real-time call to the endpoint URL and the selected objects will be modified as per the configuration.
- The webhook response and request details will then be displayed. Verify them for the expected API behaviour and click Save.