PingOne Platform APIs

Enable Users

The enable user settings control whether a user’s ability to authenticate is activated or deactivated. This endpoint gives administrators the ability to turn on (or off) a user’s active status.

For information about users, refer to User Operations.

Enable user data model

Property Type Required Mutable Description

enabled

Boolean

Required

Mutable

Specifies whether the user is enabled. This attribute is set to true by default when the user is created.

id

String

Required

Mutable

Specifies the user resource’s unique identifier.

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 enabled state errors

In addition to the general error codes, user enabled state operations can return the following errors:

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

400

INVALID_REQUEST

INVALID_VALUE

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

When and details

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

Details: Invalid value for attribute. with the target set to the field path for a JSON field conversion error, or with no target for other JSON parse failures.

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

REQUEST_FAILED

CONSTRAINT_VIOLATION

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

When and details

When: A PUT request updates the enabled state of a user with lifecycle.status of INVITED

Details: Operation not allowed for users with lifecycle.status INVITED

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 enabled attribute on the GET /users/{ID}/enabled 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:userEnabled permission (PUT operations), is not authorized for the target user’s population or group scope, or attempts to enable or disable 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.