Patch
/public/user-management/v1/users/{userId}
Updates a single user account by identifier
Security
HTTP
Type Bearer
Put ONLY your JWT Bearer token on textbox below!
Path parameters
userId
string (uuid) Required
The unique identifier of the user to update
Body parameters
object
id
string (uuid)
Unique identifier of the patch user.
fullName
string | null
username
string | null
defaultLocation
string | null
email
string | null
managedByBrand
string | null
mobileNumber
string | null
allLocationsAccess
boolean | null
allBrandFranchiseeLocationAccess
boolean | null
inActive
boolean | null
canGrantAccessBeyondPersonalLevel
string | null
userRoles
Array of object (R365.Common.Models.EntityIdReference_Of_String) | null
object
Reference to an entity by string identifier.
id
string
Identifier of the referenced entity.
locations
Array of object (R365.Common.Models.EntityIdReference_Of_String) | null
object
Reference to an entity by string identifier.
id
string
Identifier of the referenced entity.
externalLocations
Array of object (R365.Netcore.Public.Contracts.Users.Models.ExternalLocationReference) | null
object
id
string (uuid)
Unique identifier of the external location.
tenant
string
reportRoles
Array of object (R365.Common.Models.EntityIdReference_Of_String) | null
object
Reference to an entity by string identifier.
id
string
Identifier of the referenced entity.
optionIds
Array of object (R365.Common.Models.EntityIdReference_Of_Int32) | null
object
Reference to an entity by numeric identifier.
id
integer (int32)
Identifier of the referenced entity.
Responses
200
Users updated successfully.
object
success
Array of object (R365.Netcore.Public.Contracts.Users.UserCreated)
object
id
string (uuid)
Unique identifier of the user created.
username
string
userErrors
Array
Example[]
400
Bad request, more than one validation errors occurred.
object
success
Array
Example[]
userErrors
Array of object (R365.Netcore.Public.Contracts.Users.UserErrors)
object
username
string
errors
Array of object (R365.Netcore.Public.Contracts.Users.ErrorMessage)
object
error
string | null
errorCode
string | null
404
Not Found – one or more requested resources could not be located.
object
success
Array
Example[]
userErrors
Array of object (R365.Netcore.Public.Contracts.Users.UserErrors)
Example[
{
"message": "The following role IDs do not exist: [172cb15b-131e-43d3-83af-c5016c1b858f]",
"errorCode": "urn:r365:user:roles-not-found"
},
{
"message": "The following location IDs do not exist: [172cb15b-131e-43d3-83af-c5016c1b858f]",
"errorCode": "urn:r365:user:locations-not-found"
},
{
"message": "The following externalLocation IDs do not exist: [172cb15b-131e-43d3-83af-c5016c1b858f]",
"errorCode": "urn:r365:user:external-locations-not-found"
},
{
"message": "The following reportRole IDs do not exist: [172cb15b-131e-43d3-83af-c5016c1b858f]",
"errorCode": "urn:r365:user:report-roles-not-found"
},
{
"message": "The specified value for field 'defaultLocation' is unknown",
"errorCode": "urn:r365:user:default-location-not-found"
},
{
"message": "The following Options IDs do not exist: [45, 32]",
"errorCode": "urn:r365:user:options-not-found"
}
]
object
username
string
errors
Array of object (R365.Netcore.Public.Contracts.Users.ErrorMessage)
object
error
string | null
errorCode
string | null
409
Conflict – the request could not be completed due to a conflict with the current state of the resource.
object
success
Array
Example[]
userErrors
Array of object (R365.Netcore.Public.Contracts.Users.UserErrors)
Example[
{
"message": "The specified value 'jack' for field 'username' already in use",
"errorCode": "urn:r365:user:username-conflict"
},
{
"message": "The specified value 'user@email.net' for field 'email' already in use",
"errorCode": "urn:r365:user:email-conflict"
},
{
"message": "No access to add/delete default location id 'fb3c7802-c668-4c52-98ea-477e294363bb'",
"errorCode": "urn:r365:user:user-has-no-access"
},
{
"message": "No access to delete locations granted from option",
"errorCode": "urn:r365:user:no-access-to-delete-locations-by-options"
},
{
"message": "Users with Full Access, All Locations and All Reports must have the grant access beyond personal level set to True",
"errorCode": "urn:r365::grant-beyond-personal-level-must-be-true"
},
{
"message": "Cannot set grant access beyond personal level to true when user does not have permission to edit users or roles",
"errorCode": "urn:r365::insufficient-permissions"
}
]
object
username
string
errors
Array of object (R365.Netcore.Public.Contracts.Users.ErrorMessage)
object
error
string | null
errorCode
string | null
422
Unprocessable Entity: The request was well-formed but contains semantic errors and could not be processed.
object
success
Array
Example[]
userErrors
Array of object (R365.Netcore.Public.Contracts.Users.UserErrors)
Example[
{
"message": "Field 'fullName' is required",
"errorCode": "urn:r365:user:fullname-required"
},
{
"message": "Field 'username' is required",
"errorCode": "urn:r365:user:fullname-required"
},
{
"message": "Field 'email' is required",
"errorCode": "urn:r365:user:email-required"
},
{
"message": "Field 'defaultLocation' is required",
"errorCode": "urn:r365:user:default-location-required"
},
{
"message": "The specified value for field 'canGrantAccessBeyondPersonalLevel' is invalid",
"errorCode": "urn:r365:user:can-grant-access-beyond-personal-level-invalid-value"
}
]
object
username
string
errors
Array of object (R365.Netcore.Public.Contracts.Users.ErrorMessage)
object
error
string | null
errorCode
string | null