Hanzo
OpenapiIam

Changes a person's profile, their roles, or the credentials they sign in with.

Changes a person's profile, their roles, or the credentials they sign in with.

PUT /v1/iam/users/{owner}/{name}

Addresshttps://api.hanzo.ai/v1/iam/users/{owner}/{name}
MethodPUT
Operationput_iam_users_by_owner_by_name
AuthAuthorization: Bearer $HANZO_API_KEY

Changes a person's profile, their roles, or the credentials they sign in with. Send a password to reset it; leave it out and their current one keeps working.

Who they are does not change: their organization, username and the identifier their existing sessions are keyed on all survive the write, so an update never signs anyone out.

Request

261 fields, body application/json (required).

FieldInTypeRequiredDescription
ownerpathstringyes
namepathstringyes
passwordbodystring
userbodyiam.User
user.accessKeybodystringAPI credentials. AccessSecret / AccessSecretHash / the OAuth tokens are bearer material.
user.accessSecretbodystring
user.accessSecretHashbodystring
user.accessTokenbodystring
user.addressbodystring[]
user.addressesbodyiam.Address[]
user.addresses[].citybodystring
user.addresses[].line1bodystring
user.addresses[].line2bodystring
user.addresses[].regionbodystring
user.addresses[].statebodystring
user.addresses[].tagbodystring
user.addresses[].zipCodebodystring
user.adfsbodystring
user.affiliationbodystring
user.alipaybodystring
user.amazonbodystring
user.applebodystring
user.applicationScopesbodyiam.ConsentRecord[]
user.applicationScopes[].applicationbodystring
user.applicationScopes[].grantedScopesbodystring[]
user.auth0bodystring
user.avatarbodystring
user.avatarTypebodystring
user.azureadbodystring
user.azureadb2cbodystring
user.baidubodystring
user.balancebodynumberBalance mirrors v1 for lossless migration but is authoritative in Commerce (billing.hanzo.ai), not here — do not write it from IAM.
user.balanceCreditbodynumber
user.balanceCurrencybodystring
user.battlenetbodystring
user.bilibilibodystring
user.biobodystring
user.birthdaybodystring
user.bitbucketbodystring
user.boxbodystring
user.cartbodyiam.CartItem[]
user.cart[].displayNamebodystring
user.cart[].namebodystring
user.cart[].ownerbodystring
user.cart[].pricebodynumber
user.cart[].quantitybodyinteger
user.cloudfoundrybodystring
user.countryCodebodystring
user.createdAtbodystring (date-time)
user.createdIpbodystringSign-in provenance.
user.createdTimebodystring
user.currencybodystring
user.custombodystring
user.custom2bodystring
user.custom3bodystring
user.custom4bodystring
user.custom5bodystring
user.custom6bodystring
user.custom7bodystring
user.custom8bodystring
user.custom9bodystring
user.custom10bodystring
user.dailymotionbodystring
user.deezerbodystring
user.deletedbodyboolean
user.deletedTimebodystring
user.digitaloceanbodystring
user.dingtalkbodystring
user.discordbodystring
user.displayNamebodystringProfile.
user.douyinbodystring
user.dropboxbodystring
user.educationbodystring
user.emailbodystring
user.emailVerifiedbodyboolean
user.eveonlinebodystring
user.externalIdbodystring
user.faceIdsbodyiam.FaceId[]
user.faceIds[].faceIdDatabodynumber[]
user.faceIds[].imageUrlbodystring
user.faceIds[].namebodystring
user.facebookbodystring
user.firstNamebodystring
user.fitbitbodystring
user.genderbodystring
user.giteabodystring
user.giteebodystring
user.githubbodystringLinked federated-identity subjects, one column per connector (v1 parity).
user.gitlabbodystring
user.googlebodystring
user.groupsbodystring[]
user.hashbodystring
user.herokubodystring
user.homepagebodystring
user.iambodystring
user.idbodystringId is the user's STABLE OPAQUE identifier — the value the OIDC sub claim carries. It is the v1 the legacy surface per-row UUID (e.g.
user.idCardbodystring
user.idCardTypebodystring
user.influxcloudbodystring
user.infoflowbodystring
user.instagrambodystring
user.intercombodystring
user.invitationbodystring
user.invitationCodebodystring
user.ipWhitelistbodystring
user.isAdminbodyboolean
user.isDefaultAvatarbodybooleanState flags.
user.isDeletedbodyboolean
user.isForbiddenbodyboolean
user.isOnlinebodyboolean
user.isVerifiedbodyboolean
user.kakaobodystring
user.karmabodyinteger
user.kwaibodystring
user.languagebodystring
user.larkbodystring
user.lastChangePasswordTimebodystring
user.lastNamebodystring
user.lastSigninIpbodystring
user.lastSigninTimebodystring
user.lastSigninWrongTimebodystring
user.lastfmbodystring
user.ldapbodystring
user.linebodystring
user.linkedinbodystring
user.locationbodystring
user.mailrubodystring
user.managedAccountsbodyiam.ManagedAccount[]
user.managedAccounts[].applicationbodystring
user.managedAccounts[].signinUrlbodystring
user.managedAccounts[].usernamebodystring
user.meetupbodystring
user.mfaAccountsbodyiam.MfaAccount[]
user.mfaAccounts[].accountNamebodystring
user.mfaAccounts[].issuerbodystring
user.mfaAccounts[].originbodystring
user.mfaEmailEnabledbodyboolean
user.mfaItemsbodyiam.MfaItem[]
user.mfaItems[].namebodystring
user.mfaItems[].rulebodystring
user.mfaPhoneEnabledbodyboolean
user.mfaPushEnabledbodyboolean
user.mfaPushProviderbodystring
user.mfaPushReceiverbodystring
user.mfaRadiusEnabledbodyboolean
user.mfaRadiusProviderbodystring
user.mfaRadiusUsernamebodystring
user.mfaRememberDeadlinebodystring
user.mfaRememberDigestbodystringMfaRememberDigest is the digest of the token held by the ONE browser the deadline above applies to.
user.microsoftonlinebodystring
user.multiFactorAuthsbodyiam.MfaProps[]
user.multiFactorAuths[].countryCodebodystring
user.multiFactorAuths[].enabledbodyboolean
user.multiFactorAuths[].isPreferredbodyboolean
user.multiFactorAuths[].mfaRememberInHoursbodyinteger
user.multiFactorAuths[].mfaTypebodystring
user.multiFactorAuths[].urlbodystring
user.namebodystring
user.naverbodystring
user.needUpdatePasswordbodyboolean
user.nextcloudbodystring
user.oktabodystring
user.onedrivebodystring
user.originalRefreshTokenbodystring
user.originalTokenbodystring
user.ourabodystring
user.ownerbodystringIdentity / tenancy.
user.passwordHashbodystringCredential material. PasswordHash is a one-way bcrypt digest and is verify-only.
user.passwordSaltbodystring
user.passwordTypebodystring
user.patreonbodystring
user.paypalbodystring
user.permanentAvatarbodystring
user.permissionsbodyiam.Permission[]
user.permissions[].actionsbodystring[]
user.permissions[].adapterbodystring
user.permissions[].approveTimebodystring
user.permissions[].approverbodystring
user.permissions[].createdAtbodystring (date-time)
user.permissions[].createdTimebodystringDescriptive metadata.
user.permissions[].deletedbodyboolean
user.permissions[].descriptionbodystring
user.permissions[].displayNamebodystring
user.permissions[].domainsbodystring[]
user.permissions[].effectbodystring
user.permissions[].groupsbodystring[]
user.permissions[].idbodystring
user.permissions[].isEnabledbodyboolean
user.permissions[].modelbodystringAuthorization model, targets, and decision.
user.permissions[].namebodystring
user.permissions[].ownerbodystringIdentity — the (owner, name) natural key.
user.permissions[].resourceTypebodystring
user.permissions[].resourcesbodystring[]
user.permissions[].rolesbodystring[]
user.permissions[].statebodystring
user.permissions[].submitterbodystringSubmission / approval workflow.
user.permissions[].updatedAtbodystring (date-time)
user.permissions[].usersbodystring[]Subjects the grant is evaluated for.
user.phonebodystring
user.preHashbodystring
user.preferredMfaTypebodystring
user.propertiesbodyobject
user.properties.*bodystring
user.qqbodystring
user.rankingbodyinteger
user.realNamebodystring
user.recoveryCodesbodystring[]
user.regionbodystring
user.registerSourcebodystring
user.registerTypebodystring
user.rolesbodyiam.Role[]Authorization attachments.
user.roles[].createdAtbodystring (date-time)
user.roles[].createdTimebodystring
user.roles[].deletedbodyboolean
user.roles[].descriptionbodystring
user.roles[].displayNamebodystring
user.roles[].domainsbodystring[]
user.roles[].groupsbodystring[]
user.roles[].idbodystring
user.roles[].isEnabledbodyboolean
user.roles[].namebodystring
user.roles[].ownerbodystring
user.roles[].rolesbodystring[]
user.roles[].updatedAtbodystring (date-time)
user.roles[].usersbodystring[]
user.salesforcebodystring
user.scorebodyinteger
user.shopifybodystring
user.signinWrongTimesbodyinteger
user.signupApplicationbodystring
user.slackbodystring
user.soundcloudbodystring
user.spotifybodystring
user.steambodystring
user.stravabodystring
user.stripebodystring
user.tagbodystring
user.telegrambodystring
user.tiktokbodystring
user.titlebodystring
user.totpSecretbodystring
user.tumblrbodystring
user.twitchbodystring
user.twitterbodystring
user.typebodystring
user.typetalkbodystring
user.uberbodystring
user.updatedAtbodystring (date-time)
user.updatedTimebodystring
user.verificationCodebodystring
user.vkbodystring
user.webauthnCredentialsbodyany[]Multi-factor authentication. TotpSecret and RecoveryCodes are secret verify-only material — the handler strips them from every response.
user.wechatbodystring
user.wecombodystring
user.weibobodystring
user.wepaybodystring
user.xerobodystring
user.yahoobodystring
user.yammerbodystring
user.yandexbodystring
user.zoombodystring

Response

StatusBodyMeaning
200iam.Userok

200 body — 257 fields.

FieldInTypeAlwaysDescription
accessKeybodystringAPI credentials. AccessSecret / AccessSecretHash / the OAuth tokens are bearer material.
accessSecretbodystring
accessSecretHashbodystring
accessTokenbodystring
addressbodystring[]
addressesbodyiam.Address[]
addresses[].citybodystring
addresses[].line1bodystring
addresses[].line2bodystring
addresses[].regionbodystring
addresses[].statebodystring
addresses[].tagbodystring
addresses[].zipCodebodystring
adfsbodystring
affiliationbodystring
alipaybodystring
amazonbodystring
applebodystring
applicationScopesbodyiam.ConsentRecord[]
applicationScopes[].applicationbodystring
applicationScopes[].grantedScopesbodystring[]
auth0bodystring
avatarbodystring
avatarTypebodystring
azureadbodystring
azureadb2cbodystring
baidubodystring
balancebodynumberBalance mirrors v1 for lossless migration but is authoritative in Commerce (billing.hanzo.ai), not here — do not write it from IAM.
balanceCreditbodynumber
balanceCurrencybodystring
battlenetbodystring
bilibilibodystring
biobodystring
birthdaybodystring
bitbucketbodystring
boxbodystring
cartbodyiam.CartItem[]
cart[].displayNamebodystring
cart[].namebodystring
cart[].ownerbodystring
cart[].pricebodynumber
cart[].quantitybodyinteger
cloudfoundrybodystring
countryCodebodystring
createdAtbodystring (date-time)
createdIpbodystringSign-in provenance.
createdTimebodystring
currencybodystring
custombodystring
custom2bodystring
custom3bodystring
custom4bodystring
custom5bodystring
custom6bodystring
custom7bodystring
custom8bodystring
custom9bodystring
custom10bodystring
dailymotionbodystring
deezerbodystring
deletedbodyboolean
deletedTimebodystring
digitaloceanbodystring
dingtalkbodystring
discordbodystring
displayNamebodystringProfile.
douyinbodystring
dropboxbodystring
educationbodystring
emailbodystring
emailVerifiedbodyboolean
eveonlinebodystring
externalIdbodystring
faceIdsbodyiam.FaceId[]
faceIds[].faceIdDatabodynumber[]
faceIds[].imageUrlbodystring
faceIds[].namebodystring
facebookbodystring
firstNamebodystring
fitbitbodystring
genderbodystring
giteabodystring
giteebodystring
githubbodystringLinked federated-identity subjects, one column per connector (v1 parity).
gitlabbodystring
googlebodystring
groupsbodystring[]
hashbodystring
herokubodystring
homepagebodystring
iambodystring
idbodystringId is the user's STABLE OPAQUE identifier — the value the OIDC sub claim carries. It is the v1 the legacy surface per-row UUID (e.g.
idCardbodystring
idCardTypebodystring
influxcloudbodystring
infoflowbodystring
instagrambodystring
intercombodystring
invitationbodystring
invitationCodebodystring
ipWhitelistbodystring
isAdminbodyboolean
isDefaultAvatarbodybooleanState flags.
isDeletedbodyboolean
isForbiddenbodyboolean
isOnlinebodyboolean
isVerifiedbodyboolean
kakaobodystring
karmabodyinteger
kwaibodystring
languagebodystring
larkbodystring
lastChangePasswordTimebodystring
lastNamebodystring
lastSigninIpbodystring
lastSigninTimebodystring
lastSigninWrongTimebodystring
lastfmbodystring
ldapbodystring
linebodystring
linkedinbodystring
locationbodystring
mailrubodystring
managedAccountsbodyiam.ManagedAccount[]
managedAccounts[].applicationbodystring
managedAccounts[].signinUrlbodystring
managedAccounts[].usernamebodystring
meetupbodystring
mfaAccountsbodyiam.MfaAccount[]
mfaAccounts[].accountNamebodystring
mfaAccounts[].issuerbodystring
mfaAccounts[].originbodystring
mfaEmailEnabledbodyboolean
mfaItemsbodyiam.MfaItem[]
mfaItems[].namebodystring
mfaItems[].rulebodystring
mfaPhoneEnabledbodyboolean
mfaPushEnabledbodyboolean
mfaPushProviderbodystring
mfaPushReceiverbodystring
mfaRadiusEnabledbodyboolean
mfaRadiusProviderbodystring
mfaRadiusUsernamebodystring
mfaRememberDeadlinebodystring
mfaRememberDigestbodystringMfaRememberDigest is the digest of the token held by the ONE browser the deadline above applies to.
microsoftonlinebodystring
multiFactorAuthsbodyiam.MfaProps[]
multiFactorAuths[].countryCodebodystring
multiFactorAuths[].enabledbodyboolean
multiFactorAuths[].isPreferredbodyboolean
multiFactorAuths[].mfaRememberInHoursbodyinteger
multiFactorAuths[].mfaTypebodystring
multiFactorAuths[].urlbodystring
namebodystring
naverbodystring
needUpdatePasswordbodyboolean
nextcloudbodystring
oktabodystring
onedrivebodystring
originalRefreshTokenbodystring
originalTokenbodystring
ourabodystring
ownerbodystringIdentity / tenancy.
passwordHashbodystringCredential material. PasswordHash is a one-way bcrypt digest and is verify-only.
passwordSaltbodystring
passwordTypebodystring
patreonbodystring
paypalbodystring
permanentAvatarbodystring
permissionsbodyiam.Permission[]
permissions[].actionsbodystring[]
permissions[].adapterbodystring
permissions[].approveTimebodystring
permissions[].approverbodystring
permissions[].createdAtbodystring (date-time)
permissions[].createdTimebodystringDescriptive metadata.
permissions[].deletedbodyboolean
permissions[].descriptionbodystring
permissions[].displayNamebodystring
permissions[].domainsbodystring[]
permissions[].effectbodystring
permissions[].groupsbodystring[]
permissions[].idbodystring
permissions[].isEnabledbodyboolean
permissions[].modelbodystringAuthorization model, targets, and decision.
permissions[].namebodystring
permissions[].ownerbodystringIdentity — the (owner, name) natural key.
permissions[].resourceTypebodystring
permissions[].resourcesbodystring[]
permissions[].rolesbodystring[]
permissions[].statebodystring
permissions[].submitterbodystringSubmission / approval workflow.
permissions[].updatedAtbodystring (date-time)
permissions[].usersbodystring[]Subjects the grant is evaluated for.
phonebodystring
preHashbodystring
preferredMfaTypebodystring
propertiesbodyobject
properties.*bodystring
qqbodystring
rankingbodyinteger
realNamebodystring
recoveryCodesbodystring[]
regionbodystring
registerSourcebodystring
registerTypebodystring
rolesbodyiam.Role[]Authorization attachments.
roles[].createdAtbodystring (date-time)
roles[].createdTimebodystring
roles[].deletedbodyboolean
roles[].descriptionbodystring
roles[].displayNamebodystring
roles[].domainsbodystring[]
roles[].groupsbodystring[]
roles[].idbodystring
roles[].isEnabledbodyboolean
roles[].namebodystring
roles[].ownerbodystring
roles[].rolesbodystring[]
roles[].updatedAtbodystring (date-time)
roles[].usersbodystring[]
salesforcebodystring
scorebodyinteger
shopifybodystring
signinWrongTimesbodyinteger
signupApplicationbodystring
slackbodystring
soundcloudbodystring
spotifybodystring
steambodystring
stravabodystring
stripebodystring
tagbodystring
telegrambodystring
tiktokbodystring
titlebodystring
totpSecretbodystring
tumblrbodystring
twitchbodystring
twitterbodystring
typebodystring
typetalkbodystring
uberbodystring
updatedAtbodystring (date-time)
updatedTimebodystring
verificationCodebodystring
vkbodystring
webauthnCredentialsbodyany[]Multi-factor authentication. TotpSecret and RecoveryCodes are secret verify-only material — the handler strips them from every response.
wechatbodystring
wecombodystring
weibobodystring
wepaybodystring
xerobodystring
yahoobodystring
yammerbodystring
yandexbodystring
zoombodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page