PingOne Platform APIs

Application Resources

The PingOne Authorize {{apiPath}}/v1/environments/{{envID}}/resources/{{resourceID}}/applicationResources endpoint provides operations to create, read, update, and delete application resources in PingOne.

API application resources data model

Property Type Required Mutable Description

description

String

Optional

Mutable

The application resource’s description.

id

String

N/A

Read only

The resource’s unique identifier.

name

String

Required

Mutable

The application resource name. The name value must be unique.

parent

Object

N/A

Read only

The application resource’s parent.

parent.type

String

N/A

Read only

The application resource’s parent type. Options are PING_ONE_RESOURCE.

parent.id

String

N/A

Read only

The application resource’s parent ID.

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.

Application resource errors

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

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

400

INVALID_DATA

EMPTY_VALUE or OUT_OF_RANGE or INVALID_VALUE

Message: Validation Error : [<field> <message>]

When and details

When: A POST or PUT request body omits name or supplies a blank name, or supplies a name value longer than 20 characters or containing characters other than Unicode letters, marks, numbers, spaces, forward slashes, dots, apostrophes, underscores, and hyphens, or supplies a description value that fails validation

Details: Describes the failing property, such as must not be blank for an omitted or blank name (detail EMPTY_VALUE), must contain only Unicode letters, marks, numbers, spaces, forward slashes, dots, apostrophes, underscores, or hyphens for a name with disallowed characters (detail INVALID_VALUE), or size must be between 1 and 20 for a name longer than 20 characters (detail OUT_OF_RANGE with rangeMinimumValue 1 and rangeMaximumValue 20 inner errors), for example Validation Error : [name must not be blank]. A description that exceeds 1024 characters returns size must be between 1 and 1024 (detail OUT_OF_RANGE), and a description with disallowed characters returns must contain only Unicode letters, marks, numbers, spaces, or punctuation (except $, +, <, =, >, ^, `, |, ~) (detail INVALID_VALUE).

400

INVALID_DATA

UNIQUENESS_VIOLATION

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

When and details

When: A POST request specifies an application resource name already used by another application resource on the same parent resource server, or a PUT request changes the name to one that already exists on the same parent resource server

Details: A resource with this name already exists. with target name

400

REQUEST_FAILED

CONSTRAINT_VIOLATION

Message: The request could not be completed. There was an issue processing the request.

When and details

When: A POST, PUT, GET, or DELETE request references a resourceID that exists but is not a custom PingOne SSO resource (application resources are supported only on custom resources)

Details: You can only perform this operation on custom PingOne SSO resources. with no target

400

REQUEST_FAILED

CONSTRAINT_VIOLATION

Message: The request could not be completed. There was an issue processing the request.

When and details

When: A POST request exceeds the environment’s application resource limit (128 per environment)

Details: Maximum limit of application resources per environment reached with no target

403

ACCESS_FAILED

None

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

When and details

When: The actor lacks the applicationRoles:create:applicationResource permission (POST), the applicationRoles:read:applicationResource permission (GET), the applicationRoles:update:applicationResource permission (PUT), or the applicationRoles:delete:applicationResource permission (DELETE)

Details: None.

404

NOT_FOUND

None

Message: The request could not be completed. The requested resource was not found.

When and details

When: A GET, PUT, or DELETE request references a resource server ID or application resource ID that does not exist, or a POST request references a resource server ID that does not exist

Details: None.

500

UNEXPECTED_ERROR

None

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

When and details

When: Application resource creation fails after repeated attempts (5) to generate a unique identifier

Details: None.