---
title: Images
description: Use the Images service to associate a custom image with an environment:
component: pingone-api
page_id: pingone-api:platform:images
canonical_url: https://developer.pingidentity.com/pingone-api/platform/images.html
section_ids:
  assigning-admin-roles-and-permissions-to-this-service: Assigning admin roles and permissions to this service
  images-data-model: Images data model
  image-events-generated: Image events generated
  response-codes: Response codes
---

# 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](reference/roles-and-permissions-in-pingone/permissions-by-service.html) for the service-specific permissions.

You can also choose to assign admin roles based on particular service resources. Refer to [PingOne Permissions by Resource](reference/roles-and-permissions-in-pingone/permissions-by-resource.html) when assigning admin roles per service resources.

Admin assignments to roles are set by:

* [Automatic assignment for some roles](roles/predefined-roles.html#automatic-role-assignment).

* [Group Role Assignments](group-role-assignments/group-role-assignments.html).

* [User Role Assignments](users/user-role-assignments.html).

Refer to [Roles Management](roles.html) 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](reference/audit-reporting-events.html) 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. |