Skip to main content

Update User Profile (Human)​

Update the profile information from a user. The profile includes basic information like first_name and last_name.

Path Parameters
    userId string required
Header Parameters
    x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization.

Request Body required
    firstName string required

    Possible values: non-empty and <= 200 characters

    lastName string required

    Possible values: non-empty and <= 200 characters

    nickName string

    Possible values: <= 200 characters

    displayName string required

    Possible values: non-empty and <= 200 characters

    preferredLanguage string

    Possible values: <= 10 characters

    gender string

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

    Default value: GENDER_UNSPECIFIED

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

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: 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

    resourceOwner resource_owner is the organization an object belongs to
PUT /users/:userId/profile

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/management/v1
Bearer Token
userId — path required
x-zitadel-orgid — header
Content-Type
Body required
{

  "firstName": "Gigi",

  "lastName": "Giraffe",

  "nickName": "Gigi",

  "displayName": "Gigi",

  "preferredLanguage": "en",

  "gender": "GENDER_UNSPECIFIED"

}
Accept
curl / cURL
curl -L -X PUT 'https://$CUSTOM-DOMAIN/management/v1/users/:userId/profile' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "firstName": "Gigi",
  "lastName": "Giraffe",
  "nickName": "Gigi",
  "displayName": "Gigi",
  "preferredLanguage": "en",
  "gender": "GENDER_UNSPECIFIED"
}'