PingOne Platform APIs

User Application Role Assignments

The users application role assignments endpoint implements functions to create, read, and delete the PingOne Authorize application role assignments associated with user resources. For more information about application roles and the permissions associated with each role, refer to PingOne Authorize Application Roles.

Users role assignments data model

Property Type Required Mutable Description

environment.id

String

N/A

Read only

Specifies the environment associated with the user.

id

String

Required

Mutable

Specifies the application role ID to assign to the specified user.

name

String

N/A

Read only

Specifies the name of the application role assigned to the user.

description

String

N/A

Read only

Specifies the description of the application role assigned to the user.

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.

404

The requested resource was not found.

User application role assignment errors

In addition to the general error codes, user application role assignment operations can return the following errors:

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

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 /users/{ID}/applicationRoles request assigns an application role the user already has

Details: This role has already been assigned to the user.

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 /users/{ID}/applicationRoles request exceeds the maximum number of application role assignments for the role

Details: Maximum limit of application role assignments 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:read:applicationRoleAssignment permission (GET operations), the applicationRoles:create:applicationRoleAssignment permission (POST operations), or the applicationRoles:delete:applicationRoleAssignment permission (DELETE operations)

Details: None.

404

NOT_FOUND

None

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

When and details

When: The application role ID or user ID referenced by the request does not exist, or the role assignment to delete 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: The user profile cannot be serialized when creating an assignment

Details: None.