Create an API user for the Anglepoint integration

  • Release version: Xanadu
  • Updated August 1, 2024
  • 2 minutes to read
  • Create a user who is permitted to access the APIs used by the Anglepoint integration. These APIs provide the given user access to the Anglepoint integration resources that are available on your ServiceNow instance.

    Before you begin

    Role required: admin

    About this task

    The Anglepoint integration uses the following APIs:
    Table 1. Anglepoint integration APIs
    API API path Description
    Transform (POST) /api/sn_samp_ibm_lic/ibm_data/transform Processes information for your installed IBM software.
    Get Computer /api/sn_samp_ibm_lic/ibm_data/computer Retrieves information about the virtual machines (VMs) and hosts that your IBM software is installed on.
    Get Entitlements /api/sn_samp_ibm_lic/ibm_data/entitlement Retrieves entitlement information for your installed IBM software.
    Get Classification /api/sn_samp_ibm_lic/ibm_data/classification Retrieves classification information for your installed IBM software.
    Post Classification /api/sn_samp_ibm_lic/ibm_data/classification Sends classification information for your installed IBM software.

    Procedure

    1. Navigate to All > Organization > Users and then select New.
    2. On the form, fill in the fields.
      Table 2. User form
      Field Description
      User ID Unique identifier for the user.
      First name First name of the user.
      Last name Last name of the user.
      Title Job title or job description of the user.
      Department Department that the user belongs to.
      Password needs reset Option to require the user to change the assigned password during the first login.
      Note:
      This option must be disabled.
      Locked out Option to lock the user out of the ServiceNow instance and terminate all active sessions.
      Active Option that indicates the user is active.
      Note:
      This option must be enabled.
      Web service access only Option to designate the user as a non-interactive user. Non-interactive users can use only assigned credentials to authorize API connections, including JSON, SOAP, and WSDL. See Non-interactive sessions for more information on non-interactive users.
      Note:
      This option must be enabled.
      Internal Integration User Option to designate the user as an internal integration user. See Mark service accounts as internal integration users for more information on internal integration users.
      Email Email address of the user.
      Language Language preference of the user.
      Calendar integration Calendar through which the user receives meeting invitations and notifications.
      Time zone Time zone that the user is located in.
      Date format Preferred date format for the user.
      Business phone Business phone number that is assigned to the user.
      Mobile phone Mobile phone number that is assigned to the user.
      Photo Photo of the user.
    3. Right-click the form header and then select Save.
      The form automatically reloads with additional form actions, related links, and related tabs.
    4. Generate a password for the user.
      1. Select Set Password.
        The Set Password dialog box opens.
      2. In the dialog box, select Generate.
        Your ServiceNow instance automatically generates a password for the user.
      3. Copy the value in the Password field.
        Save it in a secure location for later use.
      4. Select Save Password.
        The dialog box closes and you automatically return to the User form.
    5. Assign roles to the user.
      1. On the Roles related tab, select Edit....
      2. From the Collection list on the Edit Members form, search for and select the following roles:
        • snc_platform_rest_api_access
        • oauth_user
        • sn_samp_ibm_lic.sam_ibm_data_integrator
      3. Select the Add button (Add button.) to move the selected roles from the Collection list to the Roles List.
      4. Select Save.
        The Edit Members form closes and you automatically return to the User form.
      5. Verify that all selected roles appear on the Roles related tab.