# Configuration Item

**Sync Type: Incremental**

## Overview

The ServiceNow Configuration Item input fetches data from ServiceNow Table API. ServiceNow uses CMDB (Configuration Management Database) application
to build logical representation of assets, Services, and the relationships between them that comprise the infrastructure of your organization.
The CMDB contains base-system classes that store data about configuration items (CIs). The CMDB CI Class adds class models that extend the CMDB class hierarchy,
including class descriptions, identification rules, identifier entries, and dependent relationships if applicable.. This input accesess data from cmdb_ci table.

## Prerequisites

### Portal setup
1. Login to your ServiceNow Instance.
2. **Navigate to Users**
   - Click on `All` option and type `Users`. Select Users option from under `System Security > Users and Groups`.
3. **Create a New User**
   - Fill out the details, most importantly First name, Last name and Email. Click Submit to save the info.
   - Click on `New` button to add a new User record.
4. **Locate the new user**
   - Find the newly created user in the users list.
   - Click on the UserID to open the user record details.
5. **Assign Roles**
   - In the user record details, a new "Roles" tab will appear at the bottom.
   - Click on "Edit" under the Roles tab, which will open a new page with all available roles.
   - For the Table API, you can either add all admin roles for the tables you want to retrieve data from or add the "general" admin role to give access to all tables.
   - Save the changes.
6. **Set Password**
   - Return to the user record.
   - You will see a "Set Password" button next to the update and delete button.
   - Click the Set Password button, which will open a popup.
   - Click the "Generate" button inside the popup to create a password, then click "Save Password".
7. **Instance Name**
   - Note the instance name of the ServiceNow instance for use in later steps. For example, if the URL to your
     ServiceNow instance is https://test-demo.service-now.com, the instance name will be test-demo.

## OAuth Setup

**⚠️ Important:** Before setting up OAuth make sure you have security_admin role.

1. Navigate to **System OAuth** > **Application Registry**.
2. Click New and then click **Create an OAuth API endpoint for external clients**.
3. Enter the name of the client and click the Submit button to generate Client Secret.
4. Once generated note down Client ID and Client Secret.
5. Open the OAuth endpoint record you just created and set the **Scope Restriction** field to **Broadly Scoped**. Monad uses the ServiceNow Table API (`/api/now/table/...`), which is treated as an unscoped (platform) API, so the OAuth client must be allowed to call unscoped APIs. If **Scope Restriction** is left as securely scoped, the connection fails with `access to unscoped api is not allowed`.
6. Make sure the OAuth application user has a role that can read the table you want to ingest. For ITIL tables such as change requests, incidents, and problems this is typically the `itil` role.

## Configuration

| Setting | Type | Required | Description |
|---------|------|----------|-------------|
| Instance name | string | true | Instance name found in URL of your ServiceNow instance |
| Client ID | string | true | Client ID of the application created in the Application Registry while setting up OAuth. |
| Client Secret | string | true | Client ID of the application created in the Application Registry while setting up OAuth. |
| Backfill start time | string | No | The date to start fetching data from. If not specified, no past records will be fetched. |

## Related Articles

- [ServiceNow Table API](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/c_TableAPI.html)
- [ServiceNow OAuth](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/task/t_EnableOAuthWithREST.html)
- [ServiceNow - CMDB](https://www.servicenow.com/docs/bundle/zurich-servicenow-platform/page/product/configuration-management/concept/c_ITILConfigurationManagement.html)

## Sample Record

```json
{
    "asset": "",
    "asset_tag": "",
    "assigned": "",
    "assigned_to": "",
    "assignment_group": "",
    "attestation_score": "",
    "attestation_status": "",
    "attested": "true",
    "attested_by": "",
    "attested_date": "2025-10-10T08:24:25.745Z",
    "attributes": "",
    "business_unit": "",
    "can_print": "false",
    "category": "",
    "change_control": "",
    "checked_in": "",
    "checked_out": "",
    "comments": "",
    "company": "",
    "correlation_id": "",
    "cost": "",
    "cost_cc": "USD",
    "cost_center": "",
    "delivery_date": "",
    "department": "",
    "discovery_source": "",
    "dns_domain": "",
    "due": "",
    "due_in": "2025-10-10T08:24:25.745Z",
    "duplicate_of": "",
    "environment": "",
    "fault_count": "0",
    "first_discovered": "",
    "fqdn": "",
    "gl_account": "GL774",
    "install_date": "2025-10-10T08:24:25.745Z",
    "install_status": "1",
    "invoice_number": "IN164",
    "ip_address": "",
    "justification": "",
    "last_discovered": "",
    "lease_id": "b79cae08-6245-b2a5-467a-c922ec3c7edf",
    "life_cycle_stage": "",
    "life_cycle_stage_status": "",
    "location": "",
    "mac_address": "",
    "maintenance_schedule": "",
    "managed_by": "",
    "managed_by_group": "",
    "manufacturer": "",
    "model_id": "",
    "model_number": "",
    "monitor": "true",
    "name": "John Smith",
    "operational_status": "0",
    "order_date": "",
    "owned_by": "",
    "po_number": "",
    "product_instance_id": "",
    "purchase_date": "",
    "schedule": "",
    "serial_number": "SR971",
    "short_description": "mollit non qui nisi ut ut mollit qui ipsum excepteur",
    "skip_sync": "true",
    "start_date": "2025-10-10T08:24:25.745Z",
    "subcategory": "",
    "support_group": "",
    "supported_by": "",
    "sys_class_name": "cmdb_ci",
    "sys_class_path": "",
    "sys_created_by": "admin",
    "sys_created_on": "2025-10-10T08:24:25.745Z",
    "sys_domain": {
        "link": "https://test-demo.service-now.com/api/now/table/sys_user_group/test",
        "value": "test"
    },
    "sys_domain_path": "/",
    "sys_id": "0ad8b9c7-ea96-a50b-d3bd-58f4e5595f2d",
    "sys_mod_count": "4",
    "sys_tags": "",
    "sys_updated_by": "admin",
    "sys_updated_on": "2025-10-10T08:24:25.745Z",
    "unverified": "true",
    "vendor": "",
    "warranty_expiration": "2025-10-10T08:24:25.745Z"
}
```