Updates, via PATCH, the user with the given Id.

patch/api/user/{userId}

Request

  • Base URL: http://localhost:9011
  • URL: http://localhost:9011/api/user/{userId}
  • Auth: API key in header Authorization

Path parameters

userIdstring required

The Id of the user to update.

Headers

X-FusionAuth-TenantIdstring UUID

The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.

Request body

applicationIdstring uuid
currentPasswordstring
disableDomainBlockboolean
passwordFieldType'PLAINTEXT' | 'HASHED'

Indicates whether a password is plaintext or hashed

sendSetPasswordEmailboolean
sendSetPasswordIdentityType'email' | 'phone' | 'doNotSend'

Used to indicate which identity type a password "request" might go to. It could be used for send set passwords or send password resets.

skipVerificationboolean
verificationIdsstring[]

Example request

{
  "user": {
    "preferredLanguages": [
      "en_US"
    ],
    "birthDate": "2007-12-03",
    "timezone": "America/Denver",
    "registrations": [
      {
        "preferredLanguages": [
          "en_US"
        ],
        "timezone": "America/Denver"
      }
    ]
  }
}

Response

Success

emailVerificationIdstring
emailVerificationOneTimeCodestring
registrationVerificationIdsobject
registrationVerificationOneTimeCodesobject
tokenstring
tokenExpirationInstantinteger

The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.

Example response

{
  "user": {
    "preferredLanguages": [
      "en_US"
    ],
    "birthDate": "2007-12-03",
    "timezone": "America/Denver",
    "registrations": [
      {
        "preferredLanguages": [
          "en_US"
        ],
        "timezone": "America/Denver"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.