Create a SCIM attribute mapping

  • Release version: Australia
  • Updated March 12, 2026
  • 3 minutes to read

    • Create a SCIM attribute mapping and use it as a single source of resource to the ServiceNow table fields.

    Before you begin

    Roles required: scim_client_config_admin

    About this task

    The following are the attribute mapping types and their descriptions.
    Table 1. Attribute mapping types
    Attribute mapping type Description
    Direct The SCIM attribute is populated with the help of the Database Table Name and Database Field Name fields.
    Constant The SCIM attribute is populated with the help of a specified default value.
    Script/Custom The SCIM attribute is populated with the help of the return value of a script. This attribute requires enabling the run script option.
    Note:
    • The password attribute is not supported
    • A sample attribute mapping for the User and Group resources is part of the base system. You can use and configure the mappings based on your requirements, or you can create a new record.

    Procedure

    1. Navigate to All > SCIM Client > SCIM Provider Resource Mapping.
    2. Selected the SCIM Resource Mapping that is created for the configuration.
    3. In the  SCIM Attribute Mappings  related list, click  New.
      SCIM Provider Resource Mapping
    4. On the form, fill in the fields.
      Table 2. SCIM Attribute Mappings form
      Fields Description
      Provider Resource Mapping

      Attribute mapping for a Provider-resource combination.

      If this field is not populated automatically, then use the search option. Select the Provider Resource Mapping record.
      Schema Name

      Schema name of the SCIM attribute for which the mapping must be defined.

      For example, urn:ietf:params:scim:schemas:core:2.0:User.
      Attribute

      Attribute for which the mapping must be defined. For example, userName.
      Sub-Attribute

      Sub-Attribute (if any) for which the mapping must be defined.

      For example, if there is a complex type attribute like name.familyName, then the attribute is name and the sub-attribute is familyName.
      Field Type

      The SCIM Attribute data type. This field is auto-populated from the schemas defined by the SCIM Provider.

      For example, boolean.
      Multi-Value

      Multiple values that are assigned to the attribute. An attribute can have multiple values like work email, home email, or another email.

      For example, emails.

      This field is populated using the schemas defined by SCIM Provider.
      Filter Condition

      Some multi-valued attributes can have additional information that can be specified by using a Filter Condition. The choices of filter condition are populated using the schemas defined by the SCIM Provider.

      For example, the phoneNumbers attribute has multiple types like work, mobile, home, and so on
      Unique

      Option to uniquely identify a resource between the SCIM Client and SCIM Provider systems. Multi-valued attributes cannot be marked as unique.

      For example, for a User Resource, the username attribute can be made unique.
      Database Table Name Use this field to map the attribute table name to the ServiceNow table name. If you choose direct attribute mapping, you must define this field.

      For example, the username SCIM Attribute can be mapped to the User field in the Database Table Name field.
      Database Field Name

      TheDatabase Field Name field maps the SCIM attribute to the ServiceNow field name to be mapped with the SCIM Attribute. If you choose direct attribute mapping, you must define this field.

      For example, the username SCIM Attribute can be mapped to the User ID field in the Database Field Name field.
      Default Value

      Details about the default value that is passed to the SCIM Provider.

      Can be used if the direct attribute mapping of the field returns null, or if the default can be used to return a hard-coded value.

      In the case of a hard-coded value, the database table name and field name should be None.

      For example, the primary sub-attribute value of work email can be hard-coded as true.
      Run Script

      Option to fetch the value of the attribute via script.

      This option is required for the multi-valued attributes that don’t contain a filter condition. For a complex type of attribute, a script can supply the value at an attribute or sub-attribute level.

      For example, the Members attribute of group resource has no filter condition. So, the script option should be defined on the parent attribute level of the Members attribute.
      Script

      Script that is used to fetch the attribute value.

      The return type of script should be a string, or a JSON converted as a string.

      The output of the script should be in the proper format as expected by the provider for that attribute.
    5. Click Submit.