All pages
Powered by GitBook
1 of 1

Loading...

Update user

put

Update account user. Available for Operations account with platform account management permissions or to the user himself. Accepts a delta payload with fields to update (e.g. email, firstName, lastName, phone, settings). Returns the updated account user object.

Path parameters
accountIdstringRequired

Account identifier.

userIdstringRequired

User identifier.

Body
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
emailstringOptional
statusstringOptional
prefixstring · nullableOptional
numberstring · nullableOptional
firstNamestringOptional
lastNamestringOptional
cultureCodestringOptional
dateFormatstring · nullableOptional
languageCodestringOptional
decimalSeparatorstringOptional
groupSeparatorstringOptional
timeFormatstring · nullableOptional
timeZonestring · nullableOptional
objectTypesstring[]Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstring · nullableOptional
logostring · nullableOptional
isDefaultbooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstringOptional
group.buyersstring[]Optional
sharedAccountbooleanOptionalDeprecated
configurablebooleanOptional
defaultbooleanOptional
paidbooleanOptional
typestring[]Optional
obsoletebooleanOptional
multibooleanOptional
singlebooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
urlstring · nullableOptional
notesstring · nullableOptional
statusstringOptional
Responses
200

OK

application/json
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
emailstringOptional
statusstringOptional
prefixstring · nullableOptional
numberstring · nullableOptional
firstNamestringOptional
lastNamestringOptional
cultureCodestringOptional
dateFormatstring · nullableOptional
languageCodestringOptional
decimalSeparatorstringOptional
groupSeparatorstringOptional
timeFormatstring · nullableOptional
timeZonestring · nullableOptional
objectTypesstring[]Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstring · nullableOptional
logostring · nullableOptional
isDefaultbooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstringOptional
group.buyersstring[]Optional
sharedAccountbooleanOptionalDeprecated
configurablebooleanOptional
defaultbooleanOptional
paidbooleanOptional
typestring[]Optional
obsoletebooleanOptional
multibooleanOptional
singlebooleanOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
urlstring · nullableOptional
notesstring · nullableOptional
statusstringOptional
400

Bad Request

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
403

Forbidden

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
404

Not Found

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
put/public/v1/accounts/accounts/{accountId}/users/{userId}
PUT /public/v1/accounts/accounts/{accountId}/users/{userId} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "firstName": "Updated",
  "lastName": "Name"
}
{
  "id": "USR-3758-7092",
  "revision": 2,
  "name": "Updated Name",
  "email": "new.user@example.com",
  "firstName": "Updated",
  "lastName": "Name",
  "status": "Active",
  "account": {
    "id": "ACC-3758-7092",
    "name": "Test Account"
  },
  "groups": [
    {
      "id": "UGR-3758-7092"
    }
  ]
}

Update user in account