Update directory user

curl --request PATCH \
  --url https://api.wirespeed.co/directory/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "needsChatOpsWelcome": true,
  "credentialsExposed": true
}'

{
  "id": "<string>",
  "displayName": "<string>",
  "teamId": "<string>",
  "enabled": true,
  "directoryId": "<string>",
  "name": "<string>",
  "phoneNumber": "<string>",
  "previousPhoneNumber": "<string>",
  "title": "<string>",
  "email": "<string>",
  "additionalEmails": [
    "<string>"
  ],
  "allEmails": [
    "<string>"
  ],
  "vip": true,
  "nhi": true,
  "financial": true,
  "technical": true,
  "managerDirectoryId": "<string>",
  "managerEmail": "<string>",
  "domain": "<string>",
  "department": "<string>",
  "createdAt": "<string>",
  "integrationId": {},
  "roles": [
    "<string>"
  ],
  "lastCredentialExposure": {},
  "credentialsExposed": true,
  "numberCredentialExposures": 123,
  "lastCheckedForCredentialExposures": {},
  "needsChatOpsWelcome": true,
  "contained": true,
  "username": "<string>",
  "containable": true,
  "smsConsentReceivedAt": {},
  "administrator": true,
  "updatedAt": "<string>",
  "passwordLastChangedAt": "<string>",
  "lastSignInAt": "<string>",
  "raw": {},
  "tags": [
    {
      "id": "<string>",
      "directoryUserId": "<string>",
      "tag": "VIP",
      "automationId": "<string>",
      "teamId": "<string>",
      "overriddenByUser": true,
      "enabled": true,
      "createdAt": "<string>"
    }
  ],
  "managed": true,
  "chatOpsOnboardingUser": true
}

PATCH

directory

{id}

Update directory user

curl --request PATCH \
  --url https://api.wirespeed.co/directory/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "needsChatOpsWelcome": true,
  "credentialsExposed": true
}'

{
  "id": "<string>",
  "displayName": "<string>",
  "teamId": "<string>",
  "enabled": true,
  "directoryId": "<string>",
  "name": "<string>",
  "phoneNumber": "<string>",
  "previousPhoneNumber": "<string>",
  "title": "<string>",
  "email": "<string>",
  "additionalEmails": [
    "<string>"
  ],
  "allEmails": [
    "<string>"
  ],
  "vip": true,
  "nhi": true,
  "financial": true,
  "technical": true,
  "managerDirectoryId": "<string>",
  "managerEmail": "<string>",
  "domain": "<string>",
  "department": "<string>",
  "createdAt": "<string>",
  "integrationId": {},
  "roles": [
    "<string>"
  ],
  "lastCredentialExposure": {},
  "credentialsExposed": true,
  "numberCredentialExposures": 123,
  "lastCheckedForCredentialExposures": {},
  "needsChatOpsWelcome": true,
  "contained": true,
  "username": "<string>",
  "containable": true,
  "smsConsentReceivedAt": {},
  "administrator": true,
  "updatedAt": "<string>",
  "passwordLastChangedAt": "<string>",
  "lastSignInAt": "<string>",
  "raw": {},
  "tags": [
    {
      "id": "<string>",
      "directoryUserId": "<string>",
      "tag": "VIP",
      "automationId": "<string>",
      "teamId": "<string>",
      "overriddenByUser": true,
      "enabled": true,
      "createdAt": "<string>"
    }
  ],
  "managed": true,
  "chatOpsOnboardingUser": true
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Directory user ID

Body

application/json

needsChatOpsWelcome

boolean

Whether user needs to receive chat operations welcome message

credentialsExposed

boolean

Whether user credentials have been exposed

Response

string

required

Unique identifier for the directory user

displayName

string

required

Display name for the user

teamId

string

required

Team ID that owns this user

additionalEmails

string[]

required

Additional email addresses of the user

allEmails

string[]

required

All email addresses of the user (primary + additional)

createdAt

string

required

Timestamp when the user was created

integrationId

object

required

ID of the integration this user came from

roles

string[]

required

Roles assigned to the user

credentialsExposed

boolean

required

Whether the user's credentials have been exposed

numberCredentialExposures

number

required

Number of times user credentials have been exposed

containable

boolean

required

Whether the user can be contained via automation

Cases

Integration

Asset

Users

Team

Directory

Detection

Endpoint

Update directory user

Authorizations

Path Parameters

Body

Response