Idempotent

Delete user

Delete a user by their ID

Path Parameters

id
Type: string
required

Headers

x-corma-idempotency-key
Type: string
min length:
1

Optional client-generated key. Reusing the same key with an identical request replays the original response instead of enqueueing a duplicate task.

Responses

200
Type:

OK
connectorId
Type: stringnullable
required

The connector this user belongs to: the id of its connection, which every connector route accepts. Null when no connector holds it.

country
Type: nullable
required
Properties: 2
countryCode
Type: stringnullable
required
createdAt
Type: stringFormat: date-time
required

The timestamp of when this resource was created. ISO 8601 format.

department
Type: nullable
required
Properties: 2
departmentKey
Type: stringnullable
required
email
Type: string
required
emails
Type:
required
hrStatus
Type: enumnullable
required
values
activeterminatedpending
id
Type: string
required
idpStatus
Type: enumnullable
required
values
activesuspendedarchiveddeprovisioned
job
Type: nullable
required
Properties: 2
jobKey
Type: stringnullable
required
name
Type: string
required
personalEmail
Type: stringnullable
required
sources
Type:
required
startDate
Type: stringFormat: date-timenullable
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

terminationDate
Type: stringFormat: date-timenullable
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

type
Type: enum
required
values
employeeexternalservice_accountagent
updatedAt
Type: stringFormat: date-time
required

The timestamp of the last update to this resource. ISO 8601 format.

customFields
Type: object
Properties: 1
Headers
Headers: 1
application/json

delete/users/{id}

Show Schema

{
  "id": "string",
  "type": "employee",
  "email": "string",
  "personalEmail": "string",
  "name": "string",
  "idpStatus": "active",
  "hrStatus": "active",
  "jobKey": "string",
  "countryCode": "string",
  "departmentKey": "string",
  "startDate": "2026-10-22T16:05:12.656Z",
  "terminationDate": "2026-10-22T16:05:12.656Z",
  "emails": [
    {
      "email": "string",
      "isPrimary": true,
      "sources": [
        {
          "type": "integration_sync_unit",
          "kind": "google",
          "method": "api",
          "syncUnitId": "string",
          "label": "string",
          "author": "string",
          "isOriginating": true,
          "createdAt": "2026-10-22T16:05:12.656Z",
          "lastUpdatedAt": "2026-10-22T16:05:12.656Z"
        }
      ],
      "sourceKind": "manual"
    }
  ],
  "job": {
    "key": "string",
    "display_name": "string"
  },
  "country": {
    "country_code": "string",
    "sources": [
      {
        "type": "integration_sync_unit",
        "kind": "google",
        "method": "api",
        "syncUnitId": "string",
        "label": "string",
        "author": "string",
        "isOriginating": true,
        "createdAt": "2026-10-22T16:05:12.656Z",
        "lastUpdatedAt": "2026-10-22T16:05:12.656Z"
      }
    ]
  },
  "department": {
    "key": "string",
    "displayName": "string"
  },
  "sources": [
    {
      "type": "corma",
      "kind": "extension",
      "author": "string",
      "isOriginating": true,
      "createdAt": "2026-10-22T16:05:12.656Z",
      "lastUpdatedAt": "2026-10-22T16:05:12.656Z"
    }
  ],
  "connectorId": "string",
  "customFields": {
    "additionalProperty": "string"
  },
  "createdAt": "2026-10-22T16:05:12.656Z",
  "updatedAt": "2026-10-22T16:05:12.656Z"
}

Update user

List users