The service creates reads, updates or deletes a user object, based on the HTTP method used. This endpoint
cannot be used to update the password. See change_password.
| Request Method: | PUT |
| Output format: | a JSON document of the following format, documenting the successful update of the user object{"username":"abc","access_token":"gISIhDNIFoXEVxzefrKUcXYOFKwBfq1xDPfv4wQdDjA="}
|
| Mandatory parameters: |
username - The username of the user to update (required)
|
| Optional parameters: |
email - The user's email address
fullName - The user's full name
company - The user's company name
opt_out_of_feature_and_community_emails - Boolean flag to opt out of feature and community emails
Important: If a parameter is omitted or passed as null, that property will not be updated. Only parameters explicitly provided with non-null values will be updated. This allows for partial updates where you can update only specific fields without affecting others. |
| Examples: |
Update all properties:
curl -X PUT "http://127.0.0.1:8888/security/api/restsecurity/user?username=uhl&email=axel.uhl@sap.com&fullName=Axel%20Uhl&company=SAP%20SE"Update only email (other properties remain unchanged):
curl -X PUT "http://127.0.0.1:8888/security/api/restsecurity/user?username=uhl&email=newemail@sap.com"Update only company and opt-out flag:
curl -X PUT "http://127.0.0.1:8888/security/api/restsecurity/user?username=uhl&company=New%20Company&opt_out_of_feature_and_community_emails=true"Will provide a JSON document as explained above. |
| Request Method: | GET |
| Output format: | a JSON document of the following format{"username":"abc","access_token":"gISIhDNIFoXEVxzefrKUcXYOFKwBfq1xDPfv4wQdDjA="}
|
| Optional parameter: |
username If provided, the record for the user with that name will be shown. This requires this
user to be the currently authenticated subject, or the authenticated subject needs to
have administrator permissions.
|
| Example: | curl "http://admin:admin@127.0.0.1:8888/security/api/restsecurity/user?username=uhl"Will provide a JSON document as explained above. |
| Request Method: | DELETE |
| Output format: | An Empty response with status code 200 in case of success; error-indicating status codes otherwise |
| Mandatory parameters: |
username
|
| Example: | curl -X DELETE "http://admin:admin@127.0.0.1:8888/security/api/restsecurity/user?username=uhl" |