Step 8: Set user password

PUT {{apiPath}}/environments/{{envID}}/users/{{samlUserID}}/password

This example shows the PUT /environments/{{envID}}/users/{{samlUserID}}/password operation to set a password for the new user. The request requires the application/vnd.pingidentity.password.set+json custom content type in the Content-Type HTTP header to initate the set password operation.

This operation is an admin-level password set.

In this request:

  • The user ID ({{samlUserID}}) that you created in the previous step is required. If you're using the supplied Qodex collection, you'll find that the {{samlUserID}} variable is already set to your user ID.

  • The new password is supplied in the request body's value property.

  • Because this is an admin-level password set, the forceChange property is set to false. This indicates that a user-level password change isn't required after the first use.

  • The response returns a Status: 200 successful message and shows the user's password status of OK.

See the following topics to learn more about users:

Request Body

{"value"=>"{{userPassword}}", "forceChange"=>false}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring