Update user

Updates the user with the data sent. The user that matches the username and authenticator sent in the request is searched

Request
Security:
vc-security
Request Body schema: application/json
  • If the primary phone is sent, it is mandatory to send a phone country code.
  • Depending on the type of user, other fields may be required.
object (UserKey)
password
string
orgId
string
email
string
enabled
boolean
locked
boolean
forcePasswordChange
boolean
Default: false
expired
boolean
credentialsExpired
boolean
usingMfa
boolean
mfaSecret
string
sharedSecret
string
notes
string
createdInstant
string <date-time>
lastUpdatedInstant
string <date-time>
createdBy
string
lastUpdatedBy
string
lastName
string
firstName
string
primaryPhone
string
primaryPhoneCountryCode
string
primaryPhoneExtension
string
lastSuccessfulAuthAttempt
string <date-time>
lastFailedAuthAttempt
string <date-time>
timeZone
string
locale
string
required
Array of objects (Role) unique
Default: []
required
Array of objects (Privilege) unique
Default: []
required
Array of objects (Role) unique
required
Array of objects (Privilege) unique
id
string
isSsoUser
boolean
Default: false
Responses
200

OK

400

Bad Request. The request parameters (or body) were malformed or invalid. Fix the issues with the request and try again.

401

Unauthorized request. Make sure token was included and is valid and try again.

403

Forbidden. You are not permitted to access the requested resource.

404

Not Found. The specified resource (or resource referred to by id) was not found

post/user-service/v1/user
Request samples
application/json
{
  • "userKey": {
    },
  • "password": "string",
  • "orgId": "string",
  • "email": "string",
  • "enabled": true,
  • "locked": true,
  • "forcePasswordChange": false,
  • "expired": true,
  • "credentialsExpired": true,
  • "usingMfa": true,
  • "mfaSecret": "string",
  • "sharedSecret": "string",
  • "notes": "string",
  • "createdInstant": "2019-08-24T14:15:22Z",
  • "lastUpdatedInstant": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "lastUpdatedBy": "string",
  • "lastName": "string",
  • "firstName": "string",
  • "primaryPhone": "string",
  • "primaryPhoneCountryCode": "string",
  • "primaryPhoneExtension": "string",
  • "lastSuccessfulAuthAttempt": "2019-08-24T14:15:22Z",
  • "lastFailedAuthAttempt": "2019-08-24T14:15:22Z",
  • "timeZone": "string",
  • "locale": "string",
  • "roles": [ ],
  • "privileges": [ ],
  • "allRoles": [
    ],
  • "allPrivileges": [
    ],
  • "id": "string",
  • "isSsoUser": false
}
Response samples
application/json
{
  • "message": "Field \"name\" cannot be null",
  • "status": 400,
  • "error": "Bad Request",
  • "timestamp": "2023-12-13T19:02:31.5897497",
  • "path": "/user-service/v1"
}