Uploading a user profile icon
Request
To enable a client application to get and display the available profile icon images to the user, you must first upload these images.
To upload a profile image, send a PUT request to:
https://<host>:<port>/imagemetadata/v1/profile/{resourceId}
Headers
token
– request authentication tokenx-correlation-id
– identifier for logging, to correlate messages across a call flow
Mandatory arguments
resourceId
– the resource ID for the uploaded image (in the URL)image
– the image file to be uploaded (multipart/form-data)
The name
field shown in the API documentation is the filename of the image file being uploaded. You do not need to pass it a value explicitly.
Optional arguments
None
Response
A successful request returns an HTTP 200 status.
A bad request returns an HTTP 400 status.
Example
A successful request returns a payload that looks like this:
{
"imageId": "string"
}