Integrating with Confluence Cloud

Integrating your Software Asset Management application with the Confluence Cloud application enables you to track your software subscriptions and to reclaim unused licenses.

Currently this integration supports only one site integration per profile.

Important :

Minimize security risks and protect information by granting access only to the necessary user or API permissions.

Tableau 1. Minimal user permissions

Process	Required user role in the Confluence Cloud application	Authentication scopes
Download subscriptions	User role for confluence product	Read user groups (read:confluence-groups) Read user (read:confluence-user)
Pull user activity	User role for confluence product	Search Confluence content and space summaries (search:confluence)
Reclaim subscription	site admin	Read user groups (read:confluence-groups) Create, remove, and update user groups (write:confluence-groups)

Create a Confluence Cloud OAuth 2.0 (3LO) application

Create a Confluence Cloud OAuth 2.0 (3LO) application to enable access to the Confluence Cloud API.

Avant de commencer

Atlassian Role required: Refer to the Minimal user permissions table.

Procédure

1. From a web browser, open the Atlassian Developer portal.
2. Log in to your site admin account.
3. On the page header of the portal, select your profile icon and then select Developer console.
   The My apps page of the Atlassian Developer Console opens.
4. Select the Create app menu and then select OAuth 2.0 (3LO) integration.
   The Create a new OAuth 2.0 (3LO) integration page opens.
5. Enter a name for the OAuth 2.0 (3LO) application in the Name field.
6. Select the I agree to be bound by Atlassian's developer terms check box and then select Create.
7. Configure the authorization settings for your application.
   1. From the left navigation pane, select Authorization.
   2. Select Configure for the OAuth 2.0 (3LO) authorization type.
      The OAuth 2.0 authorization code grants (3LO) for apps page opens.
   3. In the Callback URL field, enter the URL of the OAuth provider that users are redirected to after authentication.
      Enter https://instance.service-now.com/oauth_redirect.do, where <instance> is the name of your ServiceNow instance.
   4. Select Save changes.
8. Configure API scopes for your application.
   API scopes specify the level of access that the application has to the Atlassian APIs.
   1. From the left navigation pane, select Permissions.
   2. From the list of available APIs, locate the Confluence API and then select Add.
      The Add action button automatically changes to the Configure action button.
   3. Select Configure.
      The Confluence API page opens.
   4. Add the following scopes for the Confluence API:
      • Search Confluence content and space summaries
      • Read user groups
      • Create, remove, and update user groups
      • Read user
9. Retrieve the client ID and client secret that are assigned to your application.
   1. From the left navigation pane, select Settings.
   2. In the Authentication details section, copy the values in the Client ID and Secret fields.
      Save them in a secure location for later use.

Obtain the Cloud ID value of Confluence Cloud instance

Obtain the value of the Cloud ID of the Confluence Cloud cloud instance. This value is required during the configuration of the connection record in your ServiceNow instance.

Avant de commencer

Confluence Cloud Role required: admin

Procédure

1. Log in to Atlassian Administration.
2. Select the Select button against the required organization.
3. Select the Products tab.
4. On the Products page, select Manage product on the Confluence product row.

   The URL is in the following format in a new window: https://admin.atlassian.com/o/<orgID>/products/conf/<Cloud-Id>.

5. Copy the value of the Cloud ID for later use.

Create a Confluence Cloud integration profile

Create a Confluence Cloud integration profile to track software subscriptions and optimize licensing for your Confluence Cloud applications.

Avant de commencer

To create a Confluence Cloud integration profile, request the Software Asset Management - SaaS License Management plugin (sn_sam_saas_int) from the ServiceNow Store.

Atlassian Role required: site admin

ServiceNow Role required: sam_integrator, sn_confluence_spoke.confluence_cloud_admin

Important :

You must select the Confluence Cloud Spoke check box for this integration while installing optional features on the Application Manager page. For more information about choosing the required SaaS applications, see Request SaaS License Management.

Pourquoi et quand exécuter cette tâche

If you’re using Software Asset Workspace, the option to create the Confluence Cloud integration profile in Core UI is inactive.

Procédure

1. Navigate to the integration profile.

   Interface	Action
   Core UI	Navigate to All > Software Asset > SaaS License > Direct Integration Profiles. Select New. Select Confluence Cloud Integration Profile.
   Software Asset Workspace	Navigate to License operations > User Subscriptions > Direct integration profiles. Select New. Select Confluence Cloud from the drop-down list. Select Continue.

2. On the form, fill in the fields.

   Tableau 2. Integration Profile form

   Field	Value
   Display Name	Name of the integration profile. For example, Confluence Cloud Integration.
   Status	Status of the integration profile. If you have not published the integration profile, this field is automatically set to Draft. If you have already published the integration profile, this field is automatically set to Published.
   Profile Type	Type of integration profile. This field is automatically set to Confluence Cloud Subscription.

3. Review the required user roles or API permissions specified in the Vendor configuration field for each process to minimize security risks and optimize SaaS licenses.
   Remarque :

   For more information, see Minimal user permissions table.
   1. In the Download Subscription Subflow section, verify that the Subflow field is set to Confluence Cloud Download Subscriptions.
      Remarque :

      The Download subscriptions check box is selected by default and you can't clear it.
   2. In the Calculate Activity Subflow section, verify that the Subflow field is set to Confluence Cloud Update User Activity.
      Remarque :

      The Download Activity check box is selected by default. If you clear it, the activity scheduled job SAM - Refresh <displayname> Activity isn't created.

      In the Analyze user activity field, you can also select the date and time starting from when you want to analyze the user activity. By default, you can analyze user activity up to 60 days prior to the current date and view events performed by individual users from the time you create this profile.

      Remarque :

      Software Asset Management pulls the events from the time that you start analyzing user activity irrespective of the profile creation date.

      You can modify this value in the Last activity threshold field of your software reclamation rules. For more information, see Review a software reclamation rule.
   3. In the Reclaim Subscription Subflow section, verify that the Subflow field is set to Confluence Cloud Reclaim Subscription.
      Remarque :

      The Reclaim subscriptions check box is selected by default. If you don't want to reclaim subscriptions, you can clear this check box. If you clear it, the removal candidates are created but the reclaim subscription subflow isn't triggered or the reclamation process isn't initiated.
4. Select Save.
   A draft integration profile is created.

   The Connection & Credential field appears and is automatically set to sn_conflunce_spoke.confluence_subscription_activity_reclaim when all the processes are selected.

   Remarque :

   The automatically populated value in the Connection & credential field changes based on the selection in the Download activity and Reclaim subscriptions check boxes.

   Tableau 3. Automatically populated Connection & credential values based on the selection

   Selection	Connection & credential value
   Both Download activity and Reclaim subscriptions are selected.	sn_conflunce_spoke.confluence_subscription_activity_reclaim
   Only Download activity is selected.	sn_conflunce_spoke.confluence_subscription_activity
   Only Reclaim subscriptions is selected.	sn_conflunce_spoke.confluence_subscription_reclaim
   Both Download activity and Reclaim subscriptions aren’t selected.	sn_conflunce_spoke.confluence_subscription

5. Open the connection & credential aliases record by selecting the preview icon () next to the Connection & Credential field and then selecting Open Record in the record preview.
6. On the Connection & Credential Aliases form, select the Create New Connection & Credential related link.
7. In the dialog box, fill in the fields.

   Tableau 4. Create Connection and Credential dialog box

   Field	Description
   Name	Name of the connection.
   Connection URL	Provide the URL of your Confluence Cloud instance in the https://api.atlassian.com/ex/confluence/<Cloud-ID format. For more information about getting the value of Cloud ID, see Obtain the Cloud ID value of Confluence Cloud instance.
   OAuth Client ID	Client ID that is assigned to your Confluence Cloud OAuth 2.0 (3LO) application.
   OAuth Client Secret	Client secret that is assigned to your Confluence Cloud OAuth 2.0 (3LO) application.
   OAuth Redirect URL	URL of the OAuth provider that users are redirected to after authentication. This field populates automatically based on the callback URL that you specified in Create a Confluence Cloud OAuth 2.0 (3LO) application.

8. Select Create and Get OAuth Token.
   Remarque :

   For the role required to perform this step, refer to the Minimal user permissions table.
9. When the dialog box appears, grant permission to the Confluence Cloud application.
   The dialog box closes and you automatically return to the Connection & Credential Aliases form.
10. Specify the groups that have access to Confluence products.
    By specifying these groups on your ServiceNow instance, you can retrieve data and manage licenses for only the users within these groups.
    1. In a new tab, open the Atlassian Administration portal.
    2. Log in to the admin account with a site_admin role.
    3. Select the Select button against the required organization.
    4. Select the Products tab.
    5. On the Products page, select Manage product on the Confluence product row.
    6. View the list of groups that have access to Confluence products.
       Take note of this information for later use.
    7. Return to your ServiceNow instance and navigate to Confluence Cloud > Confluence Groups.
    8. On the Confluence Groups form, select the Add Groups related link.
       The Add Confluence Groups dialog box opens.
    9. Select the Connection & Credential that was set on the integration profile.
    10. In the Available list, select the groups that have access to Confluence products.
        Conseil :

        The Available list includes all groups that are associated with your Atlassian account. Select only the groups that have access to Confluence products.
    11. Select the right arrow button to move the groups from the Available list to the Selected list.
    12. Select OK.
11. Return to your integration profile and then select the integration profile.
12. On the integration profile form, select Validate Connection to verify the connection and credential details of this integration.

    Validating the connection verifies the Download Subscriptions and Calculate Activity APIs, but not the Reclaim Subscriptions APIs.

13. After the connection is verified, select Publish.
14. In the Publish Confirmation dialog box, select OK.
    Remarque :

    If you clear the Download Activity check box after the integration profile is published, you must revalidate the connections and then republish the integration profile because the following events occur:

    • The Status field on the integration profile form changes to Draft.
    • The Validate connection button shows up on the form.
    • The current SAM - Refresh <displayname> Activity job gets deleted.

Que faire ensuite

After the integration connects, your ServiceNow instance automatically creates software models, reclamation rules, and software subscriptions that are refreshed daily.

After creating an integration profile, view information about the profile in the Software Asset Workspace by navigating to License operations > User subscription > Direct integration profiles. You can select an integration profile to view the following related lists. If all of the following related lists aren't visible for an integration profile in the default view, you can select the custom integration view from the Details tab:

• Software Models
• Unrecognized Subscription Identifiers
• Scheduled Jobs
• Scheduled Job Results
• Software Subscriptions
• Subscription Identifier Exclusion Rule
• Subscription User Exclusion Rule

After creating an integration profile, you can define subscription exclusion rules to keep certain subscriptions from license cost calculations. For more information, see Subscription exclusions for SaaS and SSO applications.

If you want to set up multiple integration profiles with unique connections, create child aliases to manage different configurations and settings for each integration profile. For more information, see Create a child alias to set up multiple Confluence Cloud integration profiles.

Review all automatically generated reclamation rules to reclaim user subscriptions. For more information, see Review a software reclamation rule.

Create software entitlements for the automatically generated software models to track used software against owned software.

• For more information on creating software entitlements in the Software Asset Management Core UI, see Create entitlements in Software Asset Management classic.
• For more information on creating software entitlements in the Software Asset Workspace, see Create entitlements in workspace.
• For more information on creating software entitlements using the Software Asset Management Playbook, see Create entitlements using the guided walk-through.

Reconciliation also runs on your subscriptions as a scheduled job or on-demand. You can view your reconciliation results in the License Workbench (Software Asset Management classic application) or the License usage view (Software Asset Workspace). Use these results to determine your license compliance position and to remediate any non-compliance.

• For more information on running reconciliation in the Software Asset Management classic application, see Run software reconciliation in Software Asset Management classic.
• For more information on running reconciliation in the Software Asset Workspace, see Run software reconciliation in the workspace.