Skip to main content

Update User​

Update all information from a user.

Path Parameters
    userId string required
Query Parameters
    username string
    profile.givenName string required
    profile.familyName string required
    profile.nickName string
    profile.displayName string
    profile.preferredLanguage string
    profile.gender string

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

    Default value: GENDER_UNSPECIFIED

    email.email string required
    email.sendCode.urlTemplate string

    "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."

    email.isVerified boolean
    phone.phone string
    phone.isVerified boolean
    password.password.password string required
    password.password.changeRequired boolean
    password.hashedPassword.hash string required

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

    password.hashedPassword.changeRequired boolean
    password.currentPassword string required
    password.verificationCode string required

    "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
    emailCode string
    phoneCode string
PUT /v2beta/users/:userId

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN
Bearer Token
userId — path required
profile.givenName — query required
profile.familyName — query required
email.email — query required
password.password.password — query required
password.hashedPassword.hash — query required
password.currentPassword — query required
password.verificationCode — query required
username — query
profile.nickName — query
profile.displayName — query
profile.preferredLanguage — query
profile.gender — query
email.sendCode.urlTemplate — query
email.isVerified — query
phone.phone — query
phone.isVerified — query
password.password.changeRequired — query
password.hashedPassword.changeRequired — query
Accept
curl / cURL
curl -L -X PUT 'https://$CUSTOM-DOMAIN/v2beta/users/:userId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'