PingOne Platform APIs

Images

Use the Images service to associate a custom image with an environment:

  • For use with logos for the Branding service.

  • For icons displayed in the PingOne dock.

Assigning admin roles and permissions to this service

Admin role assignments determine access to PingOne APIs. When assigning admin roles to this service, refer to PingOne Permissions by Service for the service-specific permissions.

You can also choose to assign admin roles based on particular service resources. Refer to PingOne Permissions by Resource when assigning admin roles per service resources.

Admin assignments to roles are set by:

Refer to Roles Management for more information.

Images data model

Property Type Required Mutable Description

createdAt

String

N/A

Read-only

The time the resource was created.

environment.id

String

N/A

Read-only

The environment resource’s unique identifier.

id

String

N/A

Read-only

The resource’s unique identifier.

targets.height

String

Required

Mutable

The height of the image (in pixels).

targets.href

String

Optional

Mutable

The URL or fully qualified path to the image source file.

targets.id

String

Optional

Mutable

The UUID of the target image.

targets.type

String

Optional

Mutable

The type of format used for the image. Options are jpg, png, and gif.

targets.width

String

Optional

Mutable

The width of the image (in pixels).

Image events generated

Refer to Audit Reporting Events for the events generated.

Response codes

Code Message

200

Successful operation.

201

Successfully created.

401

You do not have access to this resource.

403

You do not have permissions or are not licensed to make this request.

Images errors

In addition to the general error codes, images operations can return the following errors:

HTTP status Top‑level code Detail code When it happens and what the response contains

400

INVALID_REQUEST

None

Message: Invalid size, Failed to get image file name., Invalid image file format: <fileName>, or Invalid mime type: <mimeType>

When and details

When: A POST /images request supplies an image that fails validation: the file is larger than 2 MB, the Content-Disposition header is missing or does not provide a filename to name the uploaded file, the file name extension is not jpg or jpeg, png, or gif, or the file content is not a decodable image of that type

Details: None.

403

ACCESS_FAILED

None

Message: The actor attempting to perform the request is not authorized.

When and details

When: The actor lacks the image:create:image permission (POST), the image:read:image permission (GET), or the image:delete:image permission (DELETE)

Details: None.

404

NOT_FOUND

None

Message: Image not found for id: <imageId>

When and details

When: GET /images/{imageID} or DELETE /images/{imageID} references an image that does not exist in the environment

Details: None.