PingOne Platform APIs

Application Role Permissions

The PingOne Authorize {{apiPath}}/v1/environments/{{envID}}/applicationRoles/{{appRoleID}}/permissions endpoint provides operations to add, read, and delete the permissions associated with application roles.

Application roles permissions data model

Property Type Required Mutable Description

action

String

N/A

Read-only

The action associated with this permission.

description

String

N/A

Read-only

The permission description.

id

String

N/A

Read-only

The permission’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 of the resource associated with this role.

resource.name

String

N/A

Read-only

The name of the resource associated with this role.

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

In addition to the general error codes, application role permission 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

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

When and details

When: A POST request omits the id property from the request body

Details: must not be null for an omitted id, for example Validation Error : [id must not be null]

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 associates an application resource permission with the application role when the permission is already associated with the role

Details: This permission already exists on the role

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 maximum number of application permissions for the role

Details: Maximum limit of application permissions for role 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:applicationRoleEntry permission (POST), the applicationRoles:read:applicationRoleEntry permission (GET), or the applicationRoles:delete:applicationRoleEntry 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 POST request references an application role ID or application resource permission ID that does not exist, a GET request references an application role ID that does not exist, or a DELETE request references an application role ID or permission association that does not exist

Details: None