Update personnel employment status

Update the employment status of a personnel record

Securitybearer
Request
path Parameters
id
required
number
Request Body schema: application/json
required
employmentStatus
required
string

The new employment status for this personnel

Enum: "CURRENT_EMPLOYEE" "FORMER_EMPLOYEE" "CURRENT_CONTRACTOR" "FORMER_CONTRACTOR" "OUT_OF_SCOPE" "UNKNOWN" "SPECIAL_FORMER_EMPLOYEE" "SPECIAL_FORMER_CONTRACTOR" "FUTURE_HIRE" "SERVICE_ACCOUNT"
notHumanReason
string <= 30000 characters

Explains why the employment status of this personnel is marked as OUT_OF_SCOPE. This field is required if the employmentStatus is set to OUT_OF_SCOPE.

separationDate
string

The date when this personnel was separated from the company system. This field is required if the employmentStatus is either FORMER_EMPLOYEE or FORMER_CONTRACTOR

Responses
200
400

Malformed data and/or validation errors

401

Invalid Authorization

402

Response Code 402

You must pay to activate this feature

403

You are not allowed to perform this action

404

Record Not Found

409

There is a conflict in the business rules with this request

500

Internal server error

default

Response Code: 412

You must accept the Drata terms and conditions to use the API

put/personnel/{id}/status
Request samples
application/json
{
  • "employmentStatus": "CURRENT_EMPLOYEE",
  • "notHumanReason": "This is not a real personnel, but a placeholder for anyone in charge of X",
  • "separationDate": "2020-07-06"
}
Response samples
application/json
{
  • "id": 1,
  • "employmentStatus": "CURRENT_EMPLOYEE",
  • "notHumanReason": "This is not a real personnel, but a placeholder for anyone in charge of X",
  • "osVersion": "Windows 3.1",
  • "serialNumber": "1A2B3C4D",
  • "user": {
    • "id": 1,
    • "email": "[email protected]",
    • "firstName": "Sally",
    • "lastName": "Smith",
    • "jobTitle": "CEO",
    • "avatarUrl": "https://cdn-prod.imgpilot.com/avatar.png",
    • "drataTermsAgreedAt": "2020-07-06 12:00:00.000000",
    • "createdAt": "2020-07-06 12:00:00.000000",
    • "updatedAt": "2020-07-06 12:00:00.000000",
    • "roles": [
      • "ROLE",
      • "ANOTHER_ROLE"
      ],
    • "backgroundChecks": [
      • {
        • "id": 1,
        • "userId": 1,
        • "status": "OK",
        • "caseId": "abc123",
        • "caseInvitationId": "abc123",
        • "url": "https://app-stage.karmacheck.com/background_check/aaaaaaaa-bbbb-0000-cccc-dddddddddddd",
        • "manualCheckDate": "2020-07-06",
        • "manuallyCheckUrl": "url.com",
        • "type": "CERTN",
        • "source": "DRATA",
        • "reportData": "string",
        • "user": { },
        • "outOfScopeReason": "abc123",
        • "outOfScopeAt": "2020-07-06 12:00:00.000000",
        • "invitationEmail": "[email protected]",
        • "linkedAt": "2020-07-06 12:00:00.000000",
        • "createdAt": "2020-07-06 12:00:00.000000",
        • "updatedAt": "2020-07-06 12:00:00.000000"
        }
      ],
    • "identities": [
      • {
        • "id": 1,
        • "identityId": "1a2b3c",
        • "username": "Username",
        • "connectedAt": "2020-07-06 12:00:00.000000",
        • "disconnectedAt": "2020-07-06 12:00:00.000000",
        • "hasMfa": true,
        • "user": { },
        • "connection": {
          • "id": "1",
          • "clientType": "GOOGLE",
          • "state": "ACTIVE",
          • "connected": false,
          • "connectedAt": "2020-07-06 12:00:00.000000",
          • "failedAt": "2020-07-06 12:00:00.000000",
          • "companyId": "12341234",
          • "assignmentId": "FLk12AsS",
          • "user": { },
          • "accountId": "string",
          • "clientId": "drata.com",
          • "clientAlias": "My-connection-alias-1",
          • "manuallyUpdatedAt": "2020-07-06 12:00:00.000000",
          • "aliasUpdatedAt": "2020-07-06 12:00:00.000000",
          • "deletedAt": "2020-07-06 12:00:00.000000",
          • "requestorId": "328d3016-71f3-4485-af20-06ce8044da18",
          • "product": "",
          • "writeAccessEnabled": false,
          • "sourcePreference": "LABEL",
          • "securityLabel": "Jira Security Label",
          • "jqlQuery": "project = IT AND type = \"Offboarding\"",
          • "authorized": true,
          • "workspaces": [],
          • "providerTypes": [
            • 5
            ],
          • "code": 10010,
          • "groupLabel": "Everyone"
          },
        • "hasIdp": true,
        • "secondaryEmail": "[email protected]",
        • "firstName": "John",
        • "lastName": "Doe",
        • "startedAt": "Wed Jan 29 2025",
        • "separatedAt": "Wed Jan 29 2025",
        • "isContractor": true,
        • "jobTitle": "Engineer",
        • "managerId": "x00jk12-2312",
        • "managerName": ""
        }
      ]
    },
  • "reasonProvider": { },
  • "complianceChecks": "[]",
  • "complianceTests": "[]",
  • "startDate": "2020-07-06",
  • "separationDate": "2020-07-06",
  • "statusUpdatedAt": "2019-08-24T14:15:22Z",
  • "data": {
    • "osVersion": "MacOS 10.15.6",
    • "serialNumber": "C02T6CDJGTFL",
    • "screenLockTime": "60",
    • "agentVersion": "1.0",
    • "macAddress": "65-F9-3D-85-7B-6B,99-A9-3E-14-7A-3E",
    • "lastcheckedAt": "2020-07-06 12:00:00.000000",
    • "createdAt": "2020-07-06 12:00:00.000000",
    • "updatedAt": "2020-07-06 12:00:00.000000"
    },
  • "createdAt": "2020-07-06 12:00:00.000000",
  • "updatedAt": "2020-07-06 12:00:00.000000",
  • "devices": "[]"
}