Integrating with SmartRecruiters

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：16分

    • Integrating your Software Asset Management application with the SmartRecruiters application enables you to track your software subscriptions and deactivate stale users. The reclamation flow deactivates only the users’ access. The reclamation flow does not affect the subscription cost because SmartRecruiters is not priced based on the number of users.

    重要:
    Minimize security risks and protect information by granting access only to the necessary user or API permissions.
    Process Required user role in the SmartRecruiters application Authentication scopes
    Download subscriptions admin None
    Pull user activity admin None
    Reclaim subscription admin None

    Generate a SmartRecruiters API key

    Generate an API key for authenticating SmartRecruiters API requests.

    始める前に

    SmartRecruiters Role required: admin

    手順

    1. Log in to SmartRecruiters account by using your admin credentials to generate an API key.
    2. On the page header of the SmartRecruiters portal, select your profile icon and then select Settings/Admin.
    3. Under Company Settings, locate the Administration section and then select Apps & Integrations.
    4. Select the CREDENTIALS tab and then select NEW CREDENTIAL.
    5. When prompted to select the type of credential that you want to generate for your applications, select API key.
    6. Select Next.
    7. Enter a name for your API key in the Credentials name field.
    8. Enter a description for your API key in the Description field.
    9. Select Generate.
      SmartRecruiters automatically generates and displays your API key.
    10. Copy your API key and save it in a secure location for later use.

    Create a SmartRecruiters integration profile

    Create a SmartRecruiters integration profile to track software subscriptions and usage. Identify users that no longer require access to SmartRecruiters and deactivate their access.

    始める前に

    The Software Asset Management - SaaS License Management plugin (sn_sam_saas_int) must be installed from the ServiceNow Store.

    ServiceNow Role required: sam_integrator

    重要:
    You must select the SmartRecruiters 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.

    このタスクについて

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

    手順

    1. Navigate to the integration profile.
      InterfaceAction
      Core UI
      1. Navigate to All > Software Asset > SaaS License > Direct Integration Profiles.
      2. Select New.
      3. Select SmartRecruiters Integration Profile.
      Software Asset Workspace
      1. Navigate to License operations > User Subscriptions > Direct integration profiles.
      2. Select New.
      3. Select SmartRecruiters from the drop-down list.
      4. Select Continue.
    2. On the form, fill in the fields.
      表 : 1. Integration Profile form
      Field Description
      Display Name Name of the integration profile. For example, SmartRecruiters 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 SmartRecruiters 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.
      注:
      For more information, see Minimal user permissions table.
      1. In the Download Subscription Subflow section, verify that the Subflow field is set to SmartRecruiters Download Subscriptions.
        注:
        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 SmartRecruiters Update User Activity.
        注:
        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.
        注:
        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 SmartRecruiters Reclaim Subscription.
        注:
        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.
      Your ServiceNow instance creates a draft integration profile.

      The Connection & Credential field appears and is automatically set to sn_smartrec_spoke.SmartRecruiters.

    5. Open the connection & credential aliases record by selecting the preview icon (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 Create Connection and Credential dialog box, fill in the fields.
      表 : 2. Create Connection dialog box
      Field Description
      Connection Information
      Connection Name Name of the SmartRecruiters connection.

      This field populates automatically.
      Connection URL URL for the connection.

      This field is automatically set to https://api.smartrecruiters.com.
      Credential Information
      API Key API key for your SmartRecruiters applications.

      Enter the same API key that you generated in Generate a SmartRecruiters API key.
    8. Select Create.
      The dialog box closes and you automatically return to the integration profile form.
    9. 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.

    10. After the connection is verified, select Publish.
    11. In the Publish Confirmation dialog box, select OK.
      注:
      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.

    次のタスク

    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 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.
    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.