Example of using the REST API to set a password

(SPE2304)

The following example demonstrates how you can use an endpoint to set a password.

Related topics

Integrating-Security-PAM-with-a-third-party-application-by-using-the-REST-API

Request URL

cURL example
POST https://<ipAddress>:<portNumber>/pam/v1/setpw
  • project: Name of the project being requested
  • user: ID that is currently requesting the change
  • pamUser: PAM user ID that is being requested
  • uid: If you have defined the AllowRepeatedRequests parameter in the project, you must enter the UID returned in the request.
  • bgpwd: Passwords they would like set for the requested ID
  • upgrade: Mode they are using e.g userpool

Request header

JSON example
{"project":"project", "user":"{{user}}", "pamuser":"{{pamuser}}", "bgpwd":["{{password}}","{{password}}"], "upgrade":"{{mode}}", "sys":["{{sys1}}","{{sys2}}"]}

The following is an example response:

Response body

JSON example
{ "status": "OK" }

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*