UpdateUser

PATCH/api/v1/users/{user}

Update a user. Fields an integration owns are overwritten on its next sync.

Example request

US
Europe

curl -X PATCH \
  -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{ "displayName": "string", "email": "string" }' \
  "https://us.oblique.security/api/v1/users/{user}?updateMask=displayName,email"

Set OBLIQUE_API_KEY to your API key.

curl -X PATCH \
  -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{ "displayName": "string", "email": "string" }' \
  "https://eu.oblique.security/api/v1/users/{user}?updateMask=displayName,email"

Set OBLIQUE_API_KEY to your API key.

Path parameters

user.namestringrequired
Assigned by Oblique. Format: users/{id}

Query parameters

updateMaskstring (field-mask)
The list of fields to update.
allowMissingboolean
If set to true, and the user is not found, a new user will be created with the given name. If created in this way, update_mask is ignored.

Request body

createTimestring (date-time)read-only
Create and update timestamps.
updateTimestring (date-time)read-only
deleteTimestring (date-time)read-only
Users can only be soft-deleted to preserve logs and history.
displayNamestringrequired
Primary display name of the user.
emailstringrequired
Primary email of the user.
secondaryEmailsstring[]
Additional emails of the user. These are in addition to the primary email.
titlestring
Self reported role. “VP of Engineering”, “Senior Frontend Engineer”, “Engineering Director, Frontend”.
managerstring
Optional manager of the user.

Format: users/{user}
pictureUristring
URI for the user’s profile picture. This can either be an “https://” scheme, or an absolute path (/imgs/foo.png).
directReportCountinteger (int32)read-only
Number of direct reports to this user.
totalReportCountinteger (int32)read-only
Number of total reports to this user.
lastLoginTimestring (date-time)read-only
The time the user last logged in. Not set if the user has never logged in.

Response

200User

A user represents a human user in the directory

namestring
Assigned by Oblique. Format: users/{id}
createTimestring (date-time)read-only
Create and update timestamps.
updateTimestring (date-time)read-only
deleteTimestring (date-time)read-only
Users can only be soft-deleted to preserve logs and history.
displayNamestringrequired
Primary display name of the user.
emailstringrequired
Primary email of the user.
secondaryEmailsstring[]
Additional emails of the user. These are in addition to the primary email.
titlestring
Self reported role. “VP of Engineering”, “Senior Frontend Engineer”, “Engineering Director, Frontend”.
managerstring
Optional manager of the user.

Format: users/{user}
pictureUristring
URI for the user’s profile picture. This can either be an “https://” scheme, or an absolute path (/imgs/foo.png).
directReportCountinteger (int32)read-only
Number of direct reports to this user.
totalReportCountinteger (int32)read-only
Number of total reports to this user.
lastLoginTimestring (date-time)read-only
The time the user last logged in. Not set if the user has never logged in.

Errors

Status	Meaning
`400`	Malformed request
`401`	Missing or invalid API key
`403`	Not allowed for this API key
`404`	Not found
`429`	Too many requests
`500`	Internal server error