Skip to content

Update user data by given userId.Accessible only for admin users or if {userId} equal to current user id

Request

PUT /v2/users/{userId}
Security
API_Key
Path
userIdinteger, (int32)required
Bodyapplication/jsonrequired

Updated user data

emailstringrequired
firstNamestringrequired
fullUsageDashboardAccessobject
lastNamestringrequired
maxPagesPerAuditobject
permissionsstring
Enum:"guest""user""admin"
timezonestringrequired
usernamestringrequired
curl -i -X PUT \
  'https://api.observepoint.com/v2/users/{userId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "firstName": "string",
    "fullUsageDashboardAccess": {},
    "lastName": "string",
    "maxPagesPerAudit": {},
    "permissions": "guest",
    "timezone": "string",
    "username": "string"
  }'

Responses

successful operation

Bodyapplication/json
accountIdinteger, (int32)required
createdstring, (date-time)required
deletedstring

ISO 8601 date time string with offset when user was deleted, null if not deleted

emailstringrequired
firstNamestringrequired
fullUsageDashboardAccessbooleanrequired
idinteger, (int32)required
lastLoginstring, (date-time)
lastNamestringrequired
maxPagesPerAuditinteger, (int32)required
opOwnedboolean

True for the ObservePoint-managed primary user of the account, which can't be edited or deleted

permissionsstring
Enum:"guest""user""admin"
timezonestringrequired
updatedstring, (date-time)required
usernamestringrequired
Response
{ "accountId": 0, "created": "2019-08-24T14:15:22Z", "deleted": "string", "email": "string", "firstName": "string", "fullUsageDashboardAccess": true, "id": 0, "lastLogin": "2019-08-24T14:15:22Z", "lastName": "string", "maxPagesPerAudit": 0, "opOwned": true, "permissions": "guest", "timezone": "string", "updated": "2019-08-24T14:15:22Z", "username": "string" }