SCIM Client properties, tables, scriptable APIs, and logs

  • Release version: Yokohama
  • Updated January 30, 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 (com.snc.integration.scim2.client) plugin enables ServiceNow customers to integrate with SCIM providers for identity provisioning. It includes configurable system properties, database tables, scriptable APIs for automation, and logging capabilities to manage and monitor SCIM operations.

    Show full answer Show less

    Properties

    • Log Request Status (com.snc.integration.scim2.client.log.request.status): Controls whether logs capture all request records or only failures. Default is ALL.
    • Log Cleanup Duration (com.snc.integration.scim2.client.log.cleanup.duration): Defines how many days logs are retained before automatic cleanup. Default is 180 days.

    These properties can be managed via All > SCIM > SCIM Client Properties.

    Tables

    • SCIM Provider (sysscimprovider): Stores SCIM provider configurations including REST message details.
    • SCIM Provider Resource Mapping (sysscimproviderresourcemapping): Maps primary tables for each provider and resource.
    • SCIM Attribute Mapping (sysscimattributemapping): Defines the source of each SCIM attribute value, such as table fields or scripts.
    • SCIM Client Log (sysscimclientlogs): Records the status of each SCIM API call made to providers.

    Scriptable API

    The SCIM2Client API allows administrators to programmatically create, update, or delete identity data on SCIM providers. It is intended for use in system context scripts by admins, such as in background scripts, business rules, scheduled jobs, or Integration Hub workflows.

    Key use cases include:

    • Provisioning identities via business rules, script includes, or workflows.
    • Running scheduled or on-demand provisioning jobs.
    • Triggering provisioning scripts as non-admin users with appropriate token and attribute access permissions.

    Using these APIs helps automate identity lifecycle management and maintain synchronization with external SCIM-compliant systems.

    Logs

    Provisioning activity and status for SCIM API calls are recorded in the SCIM Client Logs. Administrators can review these logs by navigating to All > SCIM > SCIM Client Logs to monitor successful operations and troubleshoot errors.

    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.

    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.