SCIM Client properties, tables, scriptable APIs, and logs

  • Release version: Zurich
  • Updated July 31, 2025
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of SCIM Client properties, tables, scriptable APIs, and logs

    The SCIM v2 - ServiceNow Cross-domain Identity Management Client plugin (com.snc.integration.scim2.client) facilitates identity provisioning by integrating with SCIM providers. It includes configurable system properties, dedicated tables, scriptable APIs for automation, and logs to monitor provisioning activities. This enables ServiceNow customers to manage identity data efficiently and securely across systems.

    Show full answer Show less

    Key Features

    • System Properties: Control logging behavior and log retention with properties such as:
      • com.snc.integration.scim2.client.log.request.status: Choose to log all requests or only failures (default: ALL).
      • com.snc.integration.scim2.client.log.cleanup.duration: Define the number of days to retain logs before cleanup (default: 180 days).
      Properties can be configured under All > SCIM > SCIM Client Properties.
    • Tables: Specialized tables store configuration and operational data:
      • SCIM Provider (sysscimprovider): Stores SCIM provider configuration including REST message resources.
      • SCIM Provider Resource Mapping (sysscimproviderresourcemapping): Maintains mapping of providers to primary tables and resource names.
      • SCIM Attribute Mapping (sysscimattributemapping): Defines source details for SCIM attribute values, such as table fields or scripts.
      • SCIM Client Log (sysscimclientlogs): Records the status of each API call made to SCIM providers.
    • Scriptable APIs: The SCIM2Client API allows creation, update, or deletion of identity data on SCIM providers via scripts run in system context or by system admin users. Use cases include:
      • Provisioning identity data from background scripts, business rules, script includes, or workflows.
      • Running scheduled or on-demand jobs for identity provisioning.
      • Embedding provisioning calls in workflows or business rules, including those triggered by non-admin users who have token access and permission to retrieve SCIM attribute values.
      This API facilitates automated and controlled identity management workflows within ServiceNow.
    • Logs: SCIM Client Logs provide visibility into provisioning status and API call outcomes. Logs can be accessed via All > SCIM > SCIM Client Logs, assisting in monitoring and troubleshooting integration activities.

    Key Outcomes

    By leveraging the SCIM Client plugin, ServiceNow customers can:

    • Efficiently integrate identity management workflows with external SCIM providers.
    • Customize logging and retention policies to meet operational and compliance requirements.
    • Use scriptable APIs to automate identity provisioning with flexibility and control.
    • Monitor provisioning status effectively through detailed logs for operational transparency and issue resolution.

    The SCIM v2 - ServiceNow Cross-domain Identity Management Client (com.snc.integration.scim2.client) plugin includes the following system properties, tables, scriptable APIs, and logs.

    Properties

    SCIM Client adds the following system properties.
    Table 1. Properties
    Name Description
    com.snc.integration.scim2.client.log.request.status This property determines whether to write all the log records or just the error log records. The possible values are FAILURE or ALL.

    Default value: ALL
    com.snc.integration.scim2.client.log.cleanup.duration This property determines the number of days for clearing the logs.

    Default value: 180

    To set the properties, navigate to All > SCIM > SCIM Client Properties.

    Tables

    The SCIM Client adds the following tables.

    Table 2. Tables
    Name Description
    SCIM Provider (sys_scim_provider) Stores data for each SCIM provider, such as the name, REST message resource definitions, and so on.
    SCIM Provider Resource Mapping (sys_scim_provider_resource_mapping) Stores the primary table information for each provider and resource name.
    SCIM Attribute Mapping (sys_scim_attribute_mapping) Stores the source details where each SCIM attribute value should come from, such as the table field, script, and so on.
    SCIM Client Log (sys_scim_client_logs) Stores the statuses of each call triggered to SCIM Provider.

    Scriptable API

    The SCIM2Client API calls the System for Cross-domain Identity Management (SCIM) Provider (server role) to create, update, or delete data in a service provider (SP). The scriptable API of the SCIM Client should be used in the scripts that are running in the system context or by a system admin user.

    For example, you can use the script while running the integration hub workflow as a system user, while running the scheduled jobs, and so on.

    The following are some of the use cases for using the scriptable APIs:

    • As an admin, provision identity information from background scripts, business rules, script include calls, workflows, and so on.
    • As an admin, run a scheduled job or an on-demand job for identity provisioning.
    • Run a workflow or sub-workflow with the Script step using the provision scriptable API call.
    • Add the provision script directly in a business rule or script include. The script can be triggered by non-admin users. This use-case works in the following situations:
      • The user has access to the token, meaning that the user has the role to generate the token from the REST template.
      • The user has access to retrieve the SCIM attribute values from the mapped tables.

    To know more about the scriptable API, see SCIM2Client API.

    SCIM Client Logs

    The SCIM Client Logs display the provisioning status about the SCIM APIs. To view the provisioning status, navigate to All > SCIM > SCIM Client Logs.