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: object ·

    OK

    • country
      Type: object · nullable
      required
    • countryCode
      Type: string nullable
      required
    • createdAt
      Type: string Format: date-time
      required

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

    • email
      Type: string
      required
    • emails
      Type: array ·
      required
    • hrStatus
      Type: string · enumnullable
      required
      values
      • active
      • terminated
      • pending
    • id
      Type: string
      required
    • idpStatus
      Type: string · enumnullable
      required
      values
      • active
      • suspended
      • archived
      • deprovisioned
    • job
      Type: object · nullable
      required
    • jobKey
      Type: string nullable
      required
    • name
      Type: string
      required
    • personalEmail
      Type: string nullable
      required
    • sources
      Type: array ·
      required
    • startDate
      Type: string Format: date-timenullable
      required

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

    • team
      Type: object · nullable
      required
    • teamKey
      Type: string nullable
      required
    • terminationDate
      Type: string Format: date-timenullable
      required

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

    • type
      Type: string · enum
      required
      values
      • employee
      • external
      • service_account
      • agent
    • updatedAt
      Type: string Format: date-time
      required

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

    application/json
delete/users/{id}
{
  "id": "string",
  "type": "employee",
  "email": "string",
  "personalEmail": "string",
  "name": "string",
  "idpStatus": "active",
  "hrStatus": "active",
  "jobKey": "string",
  "countryCode": "string",
  "teamKey": "string",
  "startDate": "2026-07-23T16:23:32.922Z",
  "terminationDate": "2026-07-23T16:23:32.922Z",
  "emails": [
    {
      "email": "string",
      "isPrimary": true,
      "sourceKind": "manual"
    }
  ],
  "job": {
    "key": "string",
    "display_name": "string"
  },
  "country": {
    "country_code": "string"
  },
  "team": {
    "key": "string",
    "displayName": "string"
  },
  "sources": [
    {
      "type": "corma",
      "kind": "extension",
      "createdAt": "2026-07-23T16:23:32.922Z",
      "lastUpdatedAt": "2026-07-23T16:23:32.922Z"
    }
  ],
  "createdAt": "2026-07-23T16:23:32.922Z",
  "updatedAt": "2026-07-23T16:23:32.922Z"
}

OK