You can use the PUT /environments/{{envID}}/users/{{userID}} operation to update existing attribute properties. For PUT requests, the update operation removes any existing attribute property values omitted from the request body.

The recommended way to construct a PUT request is to perform a GET first and then use the response body to construct the PUT request body with your property value modifications.

The response data shows the updates for all attribute values specified in the request body.

Users who are not authenticating with PingOne must be assigned an identity provider with the identityProvider.id attribute. If identityProvider.id is not provided, PingOne is set as the default identity provider. The identityProvider.type value is read-only, and its value is dependent on the value of identityProvider.id. If identityProvider.id is not provided, the default value of identityProvider.type is PING_ONE.

Important: Users who authenticate with an authoritative identity provider cannot self-service modify their account. Their user.identityProvider.id attribute is not null and their user.identityProvider.type attribute is not PING_ONE.

Prerequisites

Property Type Required?
accountId String Optional
address.streetAddress String Optional
address.countryCode String Optional
address.locality String Optional
address.region String Optional
address.postalCode String Optional
address.zipCode String Optional
email String Optional
locale Array [String] Optional
mobilePhone String Optional
name.given String Optional
name.family String Optional
name.middle String Optional
name.honorificPrefix String Optional
name.honorificSuffix String Optional
name.formatted String Optional
nickname String Optional
photo.href String Optional
population.id String Required
preferredLanguage String Optional
primaryPhone String Optional
timeZone String Optional
title String Optional
type String Optional
username String Required

See the User operations data model for full property descriptions.