SCIM Client troubleshooting

  • Release version: Xanadu
  • Updated August 1, 2024
  • 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 troubleshooting

    This guide provides troubleshooting actions to resolve common issues when setting up or running the SCIM Client. It addresses specific error messages and suggests actionable steps to rectify them, ensuring a smoother integration process for ServiceNow customers.

    Show full answer Show less

    Key Features

    • Access Control Issues: If you encounter an error related to accessing the corecompany table, ensure the API is called in the system context rather than a user context.
    • User Authentication: For authentication errors, verify that the token is generated correctly through the corresponding REST message and that the API call is made in the system context.
    • Data Type Mismatch: If a script execution fails due to type casting (e.g., Integer to String), confirm that the SCIM attribute mapping returns a string.
    • Invalid IDs: For SCIM attributes expecting an ID, ensure the ID provided is valid within the provider system.

    Areas to Check for Troubleshooting

    • Review SCIM Client logs for detailed error messages and statuses related to each API call.
    • Utilize the request ID, provider name, resource name, and action fields in the logs for tracking specific issues.
    • Check the request body and adjust outbound call logging settings as necessary.
    • Modify log levels and increase the content limit if the request body is truncated by using the system property glide.outboundhttp.content.maxlimit.

    Troubleshooting actions can help resolve common issues when setting up or running the SCIM Client.

    Table 1. Troubleshooting
    Issue Action

    Response contains the following message:

    “message":"Unable to access the
table core_company with id: 0c441abbc6112275000025157c651c89,
Please cross check the Access control rules"

    The message is displayed if the API is called in a user context and the user does not have access to the table.

    You must make sure that the scriptable API is called in the system context.

    Response contains the following message:

    {"message":"User Not Authenticated","detail":"
Required to provide Auth information”}
    • Make sure that the token is generated through the corresponding REST message and it is valid.
    • Make sure that the scriptable API is called in the system context.

    Response contains the following message:

    Script execution failed, the reason is:
Cannot cast java.lang.Integer to java.lang.String
    		In the SCIM attribute mapping, if the field is defined to fetch from a script with this issue, then make sure that the return type should always be a string.

    Response contains the following message:

    "status": "400", 
"scimType": "invalidValue", 
"detail": "Manager id : 02826bf03710200044e0bfc8bcbe5ds8 
doesn't exist"
    		For any SCIM attribute that expects the ID, then that ID is always of the provider system. Make sure the ID that is passed in the payload is valid in the provider system.

    Areas to check for troubleshooting

    The following are some of the areas that can be checked for troubleshooting errors when using the SCIM Client:

    • If any issue is found while running any of the scriptable APIs, see the SCIM Client logs section.
      Table 2. Logs Fields
      Field Description
      Request ID Unique ID that represents a scriptable API called.
      SCIM Provider Provider name for which the API is called.
      Resource Name of the resource for which the API is called.
      Resource ID The ID for which the API is called. For deletion, the ID represents the resource ID in the provider system and the ID is in the client system.
      Action API that is called
      Status Status of the log as a success or failure
      Message Success or error message. The error message can be from the SCIM provider or because of configuration issues in the SCIM Client.
    • Check the request body by configuring and viewing outbound calls. To learn more, see Outbound web services logging.
    • Update log levels by adding the content-type, testing the sample, and navigating to corresponding the HTTP Method form in the REST message of the corresponding provider.
    • If the request body is truncated, then increase the limit by using system property glide.outbound_http.content.max_limit.