Config Sets - User Details - RESTful API

Summary:

Modify a user's password, or delete a user from a config set.

URL:

http(s)://{server hostname}/api/cfg/serverGroupConfig/{serverGroupId}/users/{username}

Methods summary

PUT Method detail

DELETE Method detail

Methods summary

• PUT Method - change a user's password.
• DELETE Method - delete a user from a config set.

PUT Method detail

Change a user's password.

Request:

Response:

In all cases, the new password will be encrypted in the output.

Example:

INPUT
curl -u admin:admin https://localhost/api/cfg/serverGroupConfig/bb816bfa-4f95-4337-9618-de220e055905/users/guy9 -X PUT -H "content-type:application/json" -d '
{
    "password": "evenmoresecret"
} '

OUTPUT
{
  "userName" : "guy9",
  "password" : "7mX0liOokUVFUZGNFUN109f0ygk=",,
  "settings" : null,
  "passwordChangeId" : 128, 
}

DELETE Method detail

Deletes a user from a config set.

Response:

'SUCCESS' when successfully deleted.

Example:

INPUT
curl -u admin:admin https://localhost/api/cfg/serverGroupConfig/82e7c418-cd48-4fbf-857b-cddb475841a2/users/guy9?media=json -X DELETE

OUTPUT
{
  "errorCode": "SUCCESS",
  "errorDetails": "user 'guy9' removed"
}