Upload organization logo

The endpoint provides functionality to upload an organization logo.

HTTP request

PUT https://$instanceId.id.nevis.cloud/nevis/api/v1/organizations/$organizationId/logo

Parameters

Parameter	In	Type	Required / Optional	Description
instanceId	path	string	required	The ID of your Identity Cloud instance
organizationId	path	string	required	The ID of the organization

Request

The organization logo upload endpoint uses multipart form-data as defined in RFC-1867.

Example Headers

Content-Type: multipart/form-data; boundary=---------------------------9051914041544843365972754266
Content-Length: 174967

Example Body

-----------------------------9051914041544843365972754266
Content-Disposition: form-data; name="upload"; filename="logo.png"
Content-Type: image/png

Content of logo.png

-----------------------------9051914041544843365972754266

Example request

Set the ID of the organization and the path to your source logo file location.

organizationId=your-organization-id-123
logoFile=/path/to/your/logo.png

curl --request PUT "https://$instanceId.id.nevis.cloud/nevis/api/v1/organizations/${organizationId}/logo" \
  --header "Authorization: Bearer $accessKey" \ 
  --form "upload=@$logoFile"

HTTP response

On success

HTTP/1.1 201 is returned if the organization logo is successfully uploaded.

The response has the following additional header Location, containing the URL of the uploaded organization logo for the organizationId:

https://$instanceId.id.nevis.cloud/nevis/api/v1/organizations/$organizationId/logo

On failure

HTTP/1.1 400 is returned if logo file is invalid.

HTTP/1.1 401 is returned if the authorization fails due to an invalid access key.

HTTP/1.1 404 is returned if no organization is found with the given organizationId.

HTTP/1.1 413 is returned if the logo file exceeds the maximal file size of 500 kilobytes.

HTTP/1.1 422 is returned if invalid request content is given.

HTTP/1.1 500 is returned if an unexpected error occurs.