{
  "opencollection": "1.0.0",
  "info": {
    "name": "Omni AI Users API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List email-only users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{instance}.omniapp.co/api/v1/users/email-only",
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "Filter users by email (partial match, case-insensitive)"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Pagination cursor from previous response"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Results per page"
              },
              {
                "name": "sortDirection",
                "value": "",
                "type": "query",
                "description": "Sort order:\n- `asc` - Ascending order (A-Z)\n- `desc` - Descending order (Z-A)\n"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieve email-only users with their user attributes, with support for cursor-based pagination and filtering"
        },
        {
          "info": {
            "name": "List users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{instance}.omniapp.co/api/scim/v2/users",
            "params": [
              {
                "name": "filter",
                "value": "userName co \"smith\"",
                "type": "query",
                "description": "Filter users using the `userName` field with SCIM operators:\n\n| Operator | Description | Example |\n|----------|-------------|---------|\n| `eq`     | Exact match | `userName eq \"blob.ross@blobsrus.co\"` |\n| `co`     | Contains substring | `userName co \"smith\"` |\n\n**Case sensitivity:**\n\n- Attribute names (`userName`, `USERNAME`) are case-insensitive\n- Operator names (`eq`, `EQ`, `co`, `CO`) are case-insensitive\n- Email comparisons are case-insensitive\n\nUsernames should be URL-encoded when passed as filters. For example, `userName eq \"user@example.com\"` will become `userName%20eq%20%22user%40example.com%22` when encoded.\n"
              },
              {
                "name": "count",
                "value": "50",
                "type": "query",
                "description": "The number of users to return per page"
              },
              {
                "name": "startIndex",
                "value": "1",
                "type": "query",
                "description": "An integer index that determines the starting point of the sorted result list"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a list of users, sorted by creation time. Use the [List embed users](/api/users/list-embed-users) endpoint to retrieve embed users.\n"
        },
        {
          "info": {
            "name": "Create user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{instance}.omniapp.co/api/scim/v2/users",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Creates a user. To manage model and connection role assignments for users, see the [User model role APIs](/api/user-model-roles)."
        },
        {
          "info": {
            "name": "Retrieve user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{instance}.omniapp.co/api/scim/v2/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "9e8719d9-276a-4964-9395-a493189a247c",
                "type": "path",
                "description": "The ID of the user to be retrieved"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieves a user using their unique ID"
        },
        {
          "info": {
            "name": "Replace user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{instance}.omniapp.co/api/scim/v2/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "9e8719d9-276a-4964-9395-a493189a247c",
                "type": "path",
                "description": "The ID of the user to be replaced"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Replaces the specified user. Per the SCIM 2.0 specification, `PUT` replaces the entire user resource: any optional attribute omitted from the request body is reset to its default value.\n\nTo update individual attributes without affecting others, use the [Update user](/api/users/update-user) endpoint, which performs a partial update via `PATCH`.\n"
        },
        {
          "info": {
            "name": "Update user",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{instance}.omniapp.co/api/scim/v2/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "9e8719d9-276a-4964-9395-a493189a247c",
                "type": "path",
                "description": "The ID of the user to be updated"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Updates the specified user by applying a list of [SCIM 2.0 patch operations](https://datatracker.ietf.org/doc/html/rfc7644#section-3.5.2). Attributes not referenced in the request are left unchanged.\n\nTo replace the entire user resource in a single request, use the [Replace user](/api/users/replace-user) endpoint.\n"
        },
        {
          "info": {
            "name": "Delete user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{instance}.omniapp.co/api/scim/v2/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "9e8719d9-276a-4964-9395-a493189a247c",
                "type": "path",
                "description": "The ID of the user to be deleted"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Deletes the specified user. Use the [Delete embed user](/api/users/delete-embed-user) endpoint to delete embed users."
        },
        {
          "info": {
            "name": "List embed users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{instance}.omniapp.co/api/scim/v2/embed/users",
            "params": [
              {
                "name": "filter",
                "value": "embedExternalId co \"sales\"",
                "type": "query",
                "description": "Filter embed users using the `userName` or `embedExternalId` fields with SCIM operators.\n\n| Operator | Description | Example |\n|----------|-------------|---------|\n| `eq`     | Exact match | `userName eq \"blob.ross@blobsrus.co\"` |\n| `co`     | Contains substring | `embedExternalId co \"sales\"` |\n\n**Case sensitivity:**\n\n- Attribute names (`userName`, `embedExternalId`) are case-insensitive\n- Operator names (`eq`, `EQ`, `co`, `CO`) are case-insensitive\n- Email comparisons are case-insensitive\n- External ID (`embedExternalId`) comparisons are case-sensitive, per SCIM spec\n\nUsernames should be URL-encoded when passed as filters. For example, `userName eq \"user@example.com\"` will become `userName%20eq%20%22user%40example.com%22` when encoded.\n"
              },
              {
                "name": "count",
                "value": "50",
                "type": "query",
                "description": "The number of users to return"
              },
              {
                "name": "startIndex",
                "value": "1",
                "type": "query",
                "description": "An integer index that determines the starting point of the sorted result list"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a list of embed users, sorted by creation time. Use the [List users](/api/users/list-users) endpoint to retrieve standard users.\n"
        },
        {
          "info": {
            "name": "Retrieve embed user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{instance}.omniapp.co/api/scim/v2/embed/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "2212aecf-a2ba-4d99-b23b-f615bc4c6522",
                "type": "path",
                "description": "The ID of the embed user to be retrieved"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieves an embed user using their unique ID. Use the [Retrieve user](/api/users/retrieve-user) endpoint to retrieve standard users."
        },
        {
          "info": {
            "name": "Delete embed user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{instance}.omniapp.co/api/scim/v2/embed/users/:userId",
            "params": [
              {
                "name": "userId",
                "value": "2212aecf-a2ba-4d99-b23b-f615bc4c6522",
                "type": "path",
                "description": "The ID of the embed user to be deleted"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Deletes the specified embed user. Use the [Delete user](/api/users/delete-user) endpoint to delete standard users."
        }
      ]
    }
  ],
  "bundled": true
}