Skip to main content

Update User

PUT 
https://$CUSTOM-DOMAIN/v2/users/human/:userId

Update all information from a user..

Request​

Path Parameters

    userId stringrequired

Body

required

    username string

    Possible values: non-empty and <= 200 characters

    profile

    object

    givenName stringrequired

    Possible values: non-empty and <= 200 characters

    familyName stringrequired

    Possible values: non-empty and <= 200 characters

    nickName string

    Possible values: <= 200 characters

    displayName string

    Possible values: <= 200 characters

    preferredLanguage string

    Possible values: <= 10 characters

    gender string

    Possible values: [GENDER_UNSPECIFIED, GENDER_FEMALE, GENDER_MALE, GENDER_DIVERSE]

    Default value: GENDER_UNSPECIFIED

    email

    object

    email stringrequired

    Possible values: non-empty and <= 200 characters

    sendCode

    object

    urlTemplate string

    Possible values: non-empty and <= 200 characters

    Optionally set a url_template, which will be used in the verification mail sent by ZITADEL to guide the user to your verification page. If no template is set, the default ZITADEL url will be used.

    The following placeholders can be used: UserID, OrgID, Code

    returnCode object
    isVerified boolean

    phone

    object

    phone string

    Possible values: <= 200 characters

    sendCode object
    returnCode object
    isVerified boolean

    password

    object

    password

    object

    password stringrequired

    Possible values: non-empty and <= 200 characters

    changeRequired boolean

    hashedPassword

    object

    hash stringrequired

    Possible values: non-empty and <= 200 characters

    "Encoded hash of a password in Modular Crypt Format: https://zitadel.com/docs/concepts/architecture/secrets#hashed-secrets"

    changeRequired boolean
    currentPassword stringrequired

    Possible values: non-empty and <= 200 characters

    verificationCode stringrequired

    Possible values: non-empty and <= 20 characters

    "the verification code generated during password reset request"

Responses​

OK

Schema

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    resourceOwner resource_owner is the organization or instance_id an object belongs to (string)
    creationDate date-time
    emailCode string
    phoneCode string
curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2/users/human/:userId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "username": "minnie-mouse",
  "profile": {
    "givenName": "Minnie",
    "familyName": "Mouse",
    "nickName": "Mini",
    "displayName": "Minnie Mouse",
    "preferredLanguage": "en",
    "gender": "GENDER_FEMALE"
  },
  "email": {
    "email": "mini@mouse.com",
    "sendCode": {
      "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
    },
    "returnCode": {},
    "isVerified": true
  },
  "phone": {
    "phone": "+41791234567",
    "sendCode": {},
    "returnCode": {},
    "isVerified": true
  },
  "password": {
    "password": {
      "password": "Secr3tP4ssw0rd!",
      "changeRequired": true
    },
    "hashedPassword": {
      "hash": "$2a$12$lJ08fqVr8bFJilRVnDT9QeULI7YW.nT3iwUv6dyg0aCrfm3UY8XR2",
      "changeRequired": true
    },
    "currentPassword": "Secr3tP4ssw0rd!",
    "verificationCode": "SKJd342k"
  }
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN
Auth
Parameters
— pathrequired
Body required
{
  "username": "minnie-mouse",
  "profile": {
    "givenName": "Minnie",
    "familyName": "Mouse",
    "nickName": "Mini",
    "displayName": "Minnie Mouse",
    "preferredLanguage": "en",
    "gender": "GENDER_FEMALE"
  },
  "email": {
    "email": "mini@mouse.com",
    "sendCode": {
      "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
    },
    "returnCode": {},
    "isVerified": true
  },
  "phone": {
    "phone": "+41791234567",
    "sendCode": {},
    "returnCode": {},
    "isVerified": true
  },
  "password": {
    "password": {
      "password": "Secr3tP4ssw0rd!",
      "changeRequired": true
    },
    "hashedPassword": {
      "hash": "$2a$12$lJ08fqVr8bFJilRVnDT9QeULI7YW.nT3iwUv6dyg0aCrfm3UY8XR2",
      "changeRequired": true
    },
    "currentPassword": "Secr3tP4ssw0rd!",
    "verificationCode": "SKJd342k"
  }
}
ResponseClear

Click the Send API Request button above and see the response here!