PingOne Platform APIs

Application Metadata

The application metadata endpoints allow administrators to manage custom JSON properties for their apps, providing a flexible way to store attributes that aren’t natively modeled. This metadata can be used for administrative purposes, such as storing contact details or other relevant information about the application.

Applications metadata data model

Property Type Required Mutable Description

metadata

JSON blob

Required

Mutable

User-defined custom metadata. The metadata must be a JSON object, and can include any custom properties that you want to associate with the application.

applicationId

String

Required

Read-only

A string that specifies the application resource ID.

environmentId

String

Required

Read-only

A string that specifies the environment associated with the application.

Response codes

Code Message

200

Successful operation.

201

Successfully created.

204

Successfully removed. No content.

400

The request could not be completed.

401

You do not have access to this resource.

403

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

404

The requested resource was not found.

500

Unexpected server error.

Application metadata errors

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

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

400

INVALID_REQUEST

CONSTRAINT_VIOLATION

Message: The request could not be completed. The request was malformed or invalid.

When and details

When: Application metadata is not enabled for the environment (applies to GET, PUT, and POST metadata operations)

Details: Application metadata is not yet available for your environment

400

INVALID_REQUEST

CONSTRAINT_VIOLATION

Message: The request could not be completed. The request was malformed or invalid.

When and details

When: The application type does not support metadata (applies to GET, PUT, and POST metadata operations) — PingID applications and platform‑managed application types such as self‑service, admin console, portal, template, portal‑link, and MCP server applications

Details: Detail CONSTRAINT_VIOLATION with target type: Metadata is not available for applications of type: <type> for platform‑managed types, or Metadata is not available for PingID applications for PingID applications.

400

INVALID_DATA

INVALID_VALUE

Message: The constraint‑violation text in the form <propertyPath> <message>. with a trailing space after the period (for example, metadata must be smaller than 10 KB. followed by a trailing space)

When and details

When: The serialized metadata object exceeds 10 KB

Details: Detail INVALID_VALUE with target metadata and message must be smaller than 10 KB

400

INVALID_DATA

INVALID_VALUE

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: The metadata property cannot be deserialized as a JSON object (a request body that is malformed JSON or supplies a value of the wrong type)

Details: The raw deserialization message with target = the JSON field path.

404

NOT_FOUND

None

Message: Unable to find Application with ID: '<applicationId>' in Environment '<environmentId>'

When and details

When: The application does not exist in the environment (applies to GET, PUT, and POST metadata operations)

Details: None.

415

INVALID_REQUEST

None

Message: The standard unsupported‑media‑type message.

When and details

When: A metadata GET, PUT, or POST request supplies an unsupported Content-Type, such as text/html (the metadata endpoints accept application/json and application/hal+json)

Details: None.

500

UNEXPECTED_ERROR

None

Message: There was an unexpected error with the service. Please try again later.

When and details

When: Previously stored metadata cannot be parsed as JSON when read for a GET or PUT operation

Details: None.