Update User Enabled

PUT {{apiPath}}/environments/{{envID}}/users/{{userID}}/enabled

You can modify the user's enabled attribute value by calling the PUT /environments/{{envID}}/users/{{userID}}/enabled endpoint.

The sample shows the PUT /environments/{{envID}}/users/{(userID}}/enabled operation to disable the user resource's ability to authenticate.

Prerequisites

  • See Users for important overview information.
PropertyTypeRequired?
idStringRequired

See the Enable Users data model for full property descriptions.

Request Body

{"enabled"=>false}

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/9a774ad6-b6b6-4179-af87-226cd68955f0/enabled"},"user":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/9a774ad6-b6b6-4179-af87-226cd68955f0"}},"enabled":false}