PingOne Platform APIs

User Populations

The user populations endpoint supports operations to read and update the population associated with a specified user.

Users data model

Property Type Required Mutable Description

id

String

Required

Mutable

Specifies the population ID associated with the user resource ID identified in the request URL.

Response codes

Code Message

200

Successful operation.

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

In addition to the general error codes, user population 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 : [id must not be null]

When and details

When: A PUT /users/{ID}/population request body omits the id property

Details: Describes the failing property.

400

INVALID_REQUEST

INVALID_VALUE or None

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

When and details

When: A PUT /users/{ID}/population request body cannot be deserialized as JSON

Details: For a JSON field conversion error, the detail is Invalid value for attribute with target = the field path. Otherwise no detail is returned.

400

INVALID_REQUEST

None

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

When and details

When: A path identifier cannot be parsed as a UUID

Details: None.

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: A PUT /users/{ID}/population request specifies a population.id that does not exist in the environment

Details: Detail INVALID_VALUE with target population.id and message Population '<populationId>' does not exist under environment '<environmentId>'.

403

ACCESS_FAILED

INSUFFICIENT_PERMISSIONS

Message: The request could not be completed. You do not have access to this resource.

When and details

When: The actor is a user whose read scopes do not include the population.id attribute on the GET /users/{ID}/population operation

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

403

ACCESS_FAILED

None

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

When and details

When: The actor lacks the dir:read:user permission (GET operations) or the dir:update:user permission (PUT operations), is not authorized for both the user’s current and the requested new population, or attempts to move self

Details: None.

404

NOT_FOUND

None

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

When and details

When: The user ID or environment ID in the request URL does not exist

Details: None.