Skip to main content

Get organization logo

The endpoint provides functionality to download an organization logo.

HTTP request

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

Parameters

ParameterInTypeRequired / OptionalDescription
instanceIdpathstringrequiredThe ID of your Identity Cloud instance
organizationIdpathstringrequiredThe ID of the organization

Example request

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

organizationId=your-organization-id-123
logoFile=/path/to/your/logo.png
curl "https://$instanceId.id.nevis.cloud/nevis/api/v1/organizations/$organizationId/logo" \
--header "Authorization: Bearer $accessKey"
--output "$logoFile"

HTTP response

On success

HTTP/1.1 200 is returned if the organization logo is successfully downloaded.

On failure

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

HTTP/1.1 404 is returned if the organization with the given organizationId does not exist or does not have a logo.

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