Patch Patch User
Updates user's information. The user id is a unique internal identifier and can be retrieved using the search API /scim/Users?filter=... Patch operation allows to send in the request only attributes that need to be changed.
the id of the user to update
d24afa39-05a1-433f-8aa9-ad41c9a3d394
the user resource updated information as a JSON string
{
"phoneNumbers": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"addresses": [
{
"locality": "string",
"country": "string",
"region": "string",
"primary": false,
"formatted": "string",
"streetAddress": "string",
"postalCode": "string",
"type": "string"
}
],
"locale": "string",
"userType": "string",
"meta": {
"lastModified": "string",
"version": "string",
"location": "string",
"created": "string"
},
"id": "string",
"resourceDescriptor": {
"endpoint": "string",
"description": "string",
"name": "string",
"attributeSchemas": [
"string"
],
"strictMode": false,
"scimObject": {
"schemas": [
"string"
]
},
"meta": {
"lastModified": "string",
"version": "string",
"location": "string",
"created": "string"
},
"externalId": "string",
"attributes": [
{
"subAttributes": [
"AttributeDescriptor Object"
],
"description": "string",
"canonicalValues": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"dataType": "string",
"required": false,
"caseExact": false,
"name": "string",
"readOnly": false,
"multiValuedChildName": "string",
"multiValued": false,
"schema": "string"
}
],
"schema": "string",
"id": "string",
"resourceDescriptor": "ResourceDescriptor Object"
},
"title": "string",
"preferredLanguage": "string",
"scimObject": {
"schemas": [
"string"
]
},
"ims": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"externalId": "string",
"entitlements": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"nickName": "string",
"urn:scim:schemas:extension:workspace:1.0": {
"distinguishedName": "CN=user1,CN=Users,DC=acme,DC=com",
"domain": "acme.com",
"internalUserType": "PROVISIONED",
"softDeleted": false,
"userPrincipalName": "[email protected]",
"userStatus": "1",
"userStoreUuid": "19175b6d-a656-451a-9d25-b62e12d90a24",
"firstLoginUrl": "string"
},
"photos": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"groups": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"active": false,
"password": "string",
"emails": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"userName": "string",
"displayName": "string",
"name": {
"honorificPrefix": "string",
"middleName": "string",
"familyName": "string",
"formatted": "string",
"givenName": "string",
"honorificSuffix": "string"
},
"roles": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"urn:scim:schemas:extension:enterprise:1.0": {
"manager": {
"displayName": "string",
"managerId": "string"
},
"employeeNumber": "100007"
},
"profileUrl": "string",
"timeZone": "string"
}
locale
userType
id
title
preferredLanguage
externalId
nickName
urn:scim:schemas:extension:workspace:1.0
active
password
userName
displayName
urn:scim:schemas:extension:enterprise:1.0
profileUrl
timeZone
The supplied JSON is incorrect
The user is not a local user and can not be updated
The specified user does not exist.
An unexpected error occurred