Nexfs Management API Documentation
Method Index
ChangePassword
Change a Users Own Secret Password using the Nexfs Management API
Action: ChangePassword
Changes the users secret used to create a temporary management api/console token
Permissions
A requesting session must have the iam/UpdateOwnSecret role enabled.
Request Parameters
A request must be made against the nexfs management console api with the ChangePassword action.
The request must be signed with a valid AWS V4 style Signature using an active temporary session security token.
Action
ChangePassword
NewSecretHash
The Calling Session Token Users new MD5 Hex encoded Secret
OldSecretHash
The Calling Session Token Users current MD5 Hex encoded Secret
Request Body
The request does not have a request body.
Response Syntax
HTTP1/1 200
<?xml version="1.0" encoding="UTF-8"?>
<RequestCompleted>
<Code>string</Code>
<ChangePassword>
<ResponseMetadata>
<RequestId>integer</RequestId>
</ResponseMetadata>
</ChangePassword>
<Resource>string</Resource>
</RequestCompleted>
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service:
RequestCompleted
Root Level tag for the successful response
Code
OK
ChangePassword
A section label with contains the change password response details
ResponseMetadata
A section label with makes the start of the response metadata
RequestId
A requestid number that identifies the request made against the management api
Resource
/nexfsconsoleapi
Errors
Also See Rest Error Responses
400 BadRequest The request was Malformed
A BadRequest will be returned if NewSecretHash or OldSecretHash is missing from the request
400 InvalidInput Current secret does not match request
401 Unauthorized The request cannot be authenticated
403 Forbidden Session does not have the rights to perform the requested action
409 NoSuchEntity No user exists with the request userid
409 NoSuchEntity No role exists with the request rolename
500 InternalServerError An Internal Error was encountered
Example Request
GET http://nexfs.example.com:9200/nexfsconsoleapi?Action=ChangePassword&NewSecretHash=9f94debc27074c380d3028c52705e891&OldSecretHash=f91dfb6c1d5834a9bd85117b4a104b28
Authorization: AWS4-HMAC-SHA256 Credential=c4fc5faad5f0495294d8d93aa9ac80c2/20220831/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=25504d8f7c0e70934ca0e5cfecfbdb373eaae55e49f1259cb68825eeaddb0952
host: nexfs.example.com
x-amz-date: 20220831T210125Z
Example Response
<?xml version="1.0" encoding="UTF-8"?>
<RequestCompleted>
<Code>Ok</Code>
<ChangePassword>
<ResponseMetadata>
<RequestId>254</RequestId>
</ResponseMetadata>
</ChangePassword>
<Resource>/nexfsconsoleapi</Resource>
</RequestCompleted>