> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Attention: List Scim Users

> List the SCIM users in Attention, optionally filtered. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the SCIM users in Attention, optionally filtered.

> [!NOTE]
>
> Tool ID: `attention_list_scim_users`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'attention_list_scim_users',
  {
    "filter": "example",
    "startIndex": 1,
    "count": 100
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute attention_list_scim_users --input '{
  "filter": "example",
  "startIndex": 1,
  "count": 100
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "schemas": [
      "example"
    ],
    "totalResults": 123,
    "startIndex": 123,
    "itemsPerPage": 123,
    "Resources": [
      {
        "id": "id_123",
        "externalId": "external_123",
        "meta": {
          "created": "example",
          "lastModified": "example",
          "version": "example"
        },
        "schemas": [
          "example"
        ],
        "userName": "Example",
        "active": true,
        "emails": [
          {}
        ],
        "phoneNumbers": [
          {}
        ],
        "name": {
          "familyName": "Example",
          "givenName": "Example"
        },
        "urn:okta:onprem_app:1.0:user:custom": {
          "roleUUID": "role_123"
        }
      }
    ]
  }
}
```

Use `deepline describe attention_list_scim_users --json` for the latest machine-readable contract.

## Input reference

Retrieves a list of users, supports filtering and pagination. Used by SCIM clients like Okta.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.filter` | `string` | No | — | Filter expression to retrieve matching users |
| `payload.startIndex` | `integer` | No | `1` | The 1-based index of the first result |
| `payload.count` | `integer` | No | `100` | Desired maximum number of query results per page |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieves a list of users, supports filtering and pagination. Used by SCIM clients like Okta.",
    "properties": {
      "filter": {
        "type": "string",
        "description": "Filter expression to retrieve matching users"
      },
      "startIndex": {
        "type": "integer",
        "description": "The 1-based index of the first result",
        "default": 1
      },
      "count": {
        "type": "integer",
        "description": "Desired maximum number of query results per page",
        "default": 100
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.schemas` | `array` | Yes | — | — |
| `result.data.totalResults` | `integer` | Yes | — | — |
| `result.data.startIndex` | `integer` | Yes | — | — |
| `result.data.itemsPerPage` | `integer` | Yes | — | — |
| `result.data.Resources` | `array` | Yes | — | — |
| `result.data.Resources[].id` | `string` | Yes | — | — |
| `result.data.Resources[].externalId` | `string` | Yes | — | — |
| `result.data.Resources[].meta` | `object` | Yes | — | — |
| `result.data.Resources[].meta.created` | `string` | No | — | — |
| `result.data.Resources[].meta.lastModified` | `string` | No | — | — |
| `result.data.Resources[].meta.version` | `string` | No | — | — |
| `result.data.Resources[].schemas` | `array` | Yes | — | — |
| `result.data.Resources[].userName` | `string` | Yes | — | — |
| `result.data.Resources[].displayName` | `string` | No | — | — |
| `result.data.Resources[].preferredLanguage` | `string` | No | — | — |
| `result.data.Resources[].locale` | `string` | No | — | — |
| `result.data.Resources[].timezone` | `string` | No | — | — |
| `result.data.Resources[].active` | `boolean` | Yes | — | — |
| `result.data.Resources[].emails` | `array` | Yes | — | — |
| `result.data.Resources[].emails[].value` | `string` | No | — | — |
| `result.data.Resources[].emails[].type` | `string` | No | — | — |
| `result.data.Resources[].emails[].primary` | `boolean` | No | — | — |
| `result.data.Resources[].phoneNumbers` | `array` | Yes | — | — |
| `result.data.Resources[].phoneNumbers[].value` | `string` | No | — | — |
| `result.data.Resources[].phoneNumbers[].type` | `string` | No | — | — |
| `result.data.Resources[].groups` | `array` | No | — | — |
| `result.data.Resources[].groups[].display` | `string` | No | — | — |
| `result.data.Resources[].groups[].value` | `string` | No | — | — |
| `result.data.Resources[].name` | `object` | Yes | — | — |
| `result.data.Resources[].name.familyName` | `string` | No | — | — |
| `result.data.Resources[].name.givenName` | `string` | No | — | — |
| `result.data.Resources[].urn:okta:onprem_app:1.0:user:custom` | `object` | Yes | — | — |
| `result.data.Resources[].urn:okta:onprem_app:1.0:user:custom.roleUUID` | `string` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "totalResults": {
            "type": "integer"
          },
          "startIndex": {
            "type": "integer"
          },
          "itemsPerPage": {
            "type": "integer"
          },
          "Resources": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "externalId": {
                  "type": "string"
                },
                "meta": {
                  "type": "object",
                  "properties": {
                    "created": {
                      "type": "string"
                    },
                    "lastModified": {
                      "type": "string"
                    },
                    "version": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "schemas": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "userName": {
                  "type": "string"
                },
                "displayName": {
                  "type": "string"
                },
                "preferredLanguage": {
                  "type": "string"
                },
                "locale": {
                  "type": "string"
                },
                "timezone": {
                  "type": "string"
                },
                "active": {
                  "type": "boolean"
                },
                "emails": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "value": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string"
                      },
                      "primary": {
                        "type": "boolean"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "phoneNumbers": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "value": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "groups": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "display": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "name": {
                  "type": "object",
                  "properties": {
                    "familyName": {
                      "type": "string"
                    },
                    "givenName": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "urn:okta:onprem_app:1.0:user:custom": {
                  "type": "object",
                  "properties": {
                    "roleUUID": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "required": [
                "active",
                "emails",
                "externalId",
                "id",
                "meta",
                "name",
                "phoneNumbers",
                "schemas",
                "urn:okta:onprem_app:1.0:user:custom",
                "userName"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "Resources",
          "itemsPerPage",
          "schemas",
          "startIndex",
          "totalResults"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Attention provider guide](https://deepline.com/docs/providers/attention/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.