Application Resource Permissions

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

Application resources permissions data model

Property Type Required Mutable Description

Property	Type	Required	Mutable	Description
`action`	String	Required	Mutable	The action associated with this permission.
`description`	String	Optional	Mutable	The resource’s description.
`environment.id`	String	N/A	Read-only	The unique identifier for the associated environment.
`id`	String	N/A	Read-only	The resource’s unique identifier.
`key`	String	N/A	Read-only	The `resource.name:action` pair of the permission.
`resource`	Object	N/A	Read-only	An object that identifies the associated application resource.
`resource.id`	String	N/A	Read-only	The ID for the associated application resource.
`resource.name`	String	N/A	Read-only	The name of the associated application resource.

action

String

Required

Mutable

The action associated with this permission.

description

String

Optional

Mutable

The resource’s description.

environment.id

String

N/A

Read-only

The unique identifier for the associated environment.

id

String

N/A

Read-only

The resource’s unique identifier.

key

String

N/A

Read-only

The resource.name:action pair of the permission.

resource

Object

N/A

Read-only

An object that identifies the associated application resource.

resource.id

String

N/A

Read-only

The ID for the associated application resource.

resource.name

String

N/A

Read-only

The name of the associated application resource.

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 permission errors

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

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

HTTP status	Top‑level code	Detail code	When it happens and what the response contains
400	`INVALID_DATA`	`EMPTY_VALUE`, `INVALID_VALUE`, or `OUT_OF_RANGE`	Message: `Validation Error : [<field> <message>]` When and details When: A `POST` or `PUT` request omits `action` or supplies a blank `action` value, or supplies an `action` 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 `action`, `must contain only Unicode letters, marks, numbers, spaces, forward slashes, dots, apostrophes, underscores, or hyphens` for an `action` with disallowed characters, or `size must be between 1 and 20` for an `action` longer than 20 characters, for example `Validation Error : [action must not be blank]`
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 `action` already used by another application resource permission on the same application resource, or a `PUT` request changes the `action` to one that already exists on the same application resource Details: `A permission with this action already exists on the resource.` The target is `action`.
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 permission limit Details: `Maximum limit of application permissions per environment reached`
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:applicationPermission` permission (`POST`), the `applicationRoles:read:applicationPermission` permission (`GET`), the `applicationRoles:update:applicationPermission` permission (`PUT`), or the `applicationRoles:delete:applicationPermission` 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` (single permission), `PUT`, or `DELETE` request references an application resource ID or permission ID that does not exist, a `GET` (all permissions for a resource) request references an application resource ID that does not exist, or a `POST` request references an application resource 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 permission creation fails after repeated attempts to generate a unique identifier Details: None

400

INVALID_DATA

EMPTY_VALUE, INVALID_VALUE, or OUT_OF_RANGE

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

When and details

When: A POST or PUT request omits action or supplies a blank action value, or supplies an action 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 action, must contain only Unicode letters, marks, numbers, spaces, forward slashes, dots, apostrophes, underscores, or hyphens for an action with disallowed characters, or size must be between 1 and 20 for an action longer than 20 characters, for example Validation Error : [action must not be blank]

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 action already used by another application resource permission on the same application resource, or a PUT request changes the action to one that already exists on the same application resource

Details: A permission with this action already exists on the resource. The target is action.

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 permission limit

Details: Maximum limit of application permissions per environment reached

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:applicationPermission permission (POST), the applicationRoles:read:applicationPermission permission (GET), the applicationRoles:update:applicationPermission permission (PUT), or the applicationRoles:delete:applicationPermission 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 (single permission), PUT, or DELETE request references an application resource ID or permission ID that does not exist, a GET (all permissions for a resource) request references an application resource ID that does not exist, or a POST request references an application resource 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 permission creation fails after repeated attempts to generate a unique identifier

Details: None

PingOne Platform APIs

Application Resource Permissions

Application resources permissions data model

Response codes

Application resource permission errors