Create a custom integration profile

Create a custom integration profile to track software subscriptions and optimize stale licenses for any SaaS application.

Before you begin

Before you create a custom integration profile in your ServiceNow instance, set up a method of authentication in the SaaS application admin or developer account. For example, create an OAuth application or an API token.

• If you create an OAuth application, confirm that you enable the appropriate scopes. The app needs scopes to read users, read user activity, and to modify or delete users. These scopes enable the integration to get a list of users, get user activity, and reclaim unused subscriptions. Record the Client ID and Client secret for the OAuth application. You input these values in your ServiceNow instance.
• If you create an API token, record the value for the API token. You input this value in your ServiceNow instance.

Role required: sam_integrator or admin

About this task

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

Procedure

1. Navigate to the custom integration profile.

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

2. On the form, fill in the fields.

   Table 1. Custom Integration Profile form

   Field	Value
   Display name	Name of the custom integration profile. For example, the name of the SaaS application that you're integrating with.
   Connection & Credential	Select the lookup icon (). Select New. On the Connection and Credential Aliases form, fill in the fields: Name: Name of your choice. For example, app_alias, where app is the name of the SaaS application that you're integrating with. Application: Spoke for connecting with the SaaS application. This spoke can be an existing Integration Hub spoke or a new spoke that you created. You can change the application in the Developer section of the System Settings . Type: Connection and Credential. Connection Type: HTTP. Support Multiple Active Connections: Not selected. Default Retry Policy: Default HTTP Retry Policy. Configuration Template: If you're using the OAuth authorization code grant type, OAuth Authorization Code. If you're using an API token, Basic Auth with API Key. If you're using another authentication method, create a configuration template. For more information, see Create a configuration template and Configure a template for OAuth JWT Bearer grant type. Select Submit.
   Status	Status of the integration profile. The options are Draft and Published. This value is automatically populated.
   Profile type	Custom Integration. This value is automatically populated.

3. Select Save.
4. Open the Connection & Credential alias record by selecting the preview icon () and then selecting Open Record.
5. Select the Create New Connection & Credential related link.
   • If you're using the OAuth Authorization Code configuration template, fill in the fields.

     Table 2. Create Connection and Credential form

     Field	Value
     Connection URL	Base URL for the API.
     Authorization URL	OAuth authorization code endpoint.
     Token URL	OAuth endpoint to retrieve and refresh access tokens.
     Token Revocation URL	OAuth endpoint to revoke access tokens.
     OAuth Redirect URL	https://instance.service-now.com/oauth_redirect.do, where instance is the name of your ServiceNow instance.
     Refresh Token Lifespan	8640000.
     OAuth Client ID	Client ID that you created in the SaaS application admin or developer account.
     OAuth Client Secret	Client secret that you created in the SaaS application admin or developer account.
     OAuth Scopes	Scopes that you enabled for your OAuth application in the SaaS application admin or developer account.

   • If you're using the Basic Auth with API Key configuration template, fill in the fields.

     Table 3. Create Connection and Credential form

     Field	Value
     Connection URL	URL for your SaaS account.
     User Name	Email address of the admin user that created the API token in the SaaS application admin or developer account.
     API Key	API token created in the SaaS application admin or developer account.

   • If you're using a different method of authentication, the available fields are determined by the configuration template that you created.
6. Select Create and grant access for the integration.
   Tip:

   Log in to your SaaS application admin account in a new browser tab to verify that the integration connects to the correct account.
   • If the connection is successful, a connection record is created in the Connections related list on the Connection & Credential Alias record.
   • If the connection fails, you must delete the connection record, credential record, and application registry record that were created during the attempted connection.
     1. To delete the connection record, navigate to Connections & Credentials > Connections and delete the record for the SaaS application.
     2. To delete the credential record, navigate to Connections & Credentials > Credentials and delete the record for the SaaS application.
     3. To delete the application registry record, navigate to System OAuth > Application Registry and delete the record for the SaaS application.
     4. Return to the Connection & Credential Alias record for the SaaS application and select the Create New Connection & Credential related link to reattempt the connection.

What to do next

Create a data stream action to get users and view SaaS related analytics on SaaS overview dashboard.

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.