Update Profile User

Use this API to update the user profile.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

PUT https://{tenantId}.{hostname}/digitanium/v4/users/{userName}/profile

HTTP request URL for SHIFT

PUT https://{hostname}/auth/realms/{tenantId}/v3_user/{userName}/profile

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameter fields are required.

Request body

Field Name	Type	Description
firstName	string	First name of the user.
lastName	string	Last name of the user.
email	string	Email of the user.
attributes	Object	Key value pair containing the attributes you wanted to update.

Sample Request

{
	"firstName": "Foo",
	"lastName": "Bar",
	"email" : "example@email.com",
	"attributes": {
		"attribute1": "value",
		"attribute2": "value2",
		"attribute3": "value3"
	}
}

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response

{
    "message": "User profile updated successfully.",
    "status": "OK",
    "subSystem": 5
}

Response Status Information

Status Code	Status	Message
200	OK	User profile updated successfully
400	GENERAL ERROR	Failed to update profileCaused by null
401	Unauthorized	HTTP 401 Unauthorized
404	USER_NOT_FOUND	User does not exist