Update an Existing User using the Nexfs Management API

Action: UpdateUser

Updates an existing User

Permissions

To update a role a requesting session must have the iam/UpdateUsers role enabled.

To change any users management password using the UpdateUser action the calling section must have the iam/UpdateOtherUserSecret role enabled. Note: the ChangePassword action should be used to change a users own password when the user does not have the iam/UpdateOtherUserSecret role enabled.

To change any users content (s3 protocol) secret using the UpdateUser action the calling section must have the iam/UpdateOtherUserContentSecret role enabled

Request Parameters

A request must be made against the nexfs management console api with the UpdateUser action.

The request must be signed with a valid AWS V4 style Signature using an active temporary session security token.

Action

UpdateUser

Description (Optional)

A URI encoded json string containing optional the description elements for the new user

Description json Format

{

"UserDescription1": "string",

"UserDescription2": "string",

}

Description json elements

UserDescription1

The json label for an optional user description

UserDescription2

The json label for an additional optional user description

string

The optional user descriptions

Email (Optional)

The email address for the user

NewContentSecret (Optional)

The Users Secret for access Nexfs over the S3 protocol

NewSecretHash (Optional)

The Users MD5 Hex encoded Secret

NewUserId (Optional)

The new Users Id (The account id/name used for that user to authenticate against the API)

UserId

The current User Id (The account id/name used for that user to authenticate against the API)

UserName (Optional)

A new short description of the user, often the users or automated systems name

UserPOSIXUID

When set, the users configured posix user id (uid)

UserPOSIXGID

When set, the users configured prmiary posix group id (gid)

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>

<UpdateUserResponse>

<UpdateUserResult>

<User>

<UserName>String</UserName>

<UserId>String</UserId>

</User>

</UpdateUserResult>

<ResponseMetadata>

<RequestId>integer</RequestId>

</ResponseMetadata>

</UpdateUserResponse>

<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 Revoke Session response

Code

OK

UpdateUserResponse

A section label with contains the update user response details

UpdateUserResult

A section label which contains confirms the user that has been updated

User

A section label which contains a summary of the user that has been updated

UserId

The (updated) Users Id (The account id/name used for that user to authenticate against the API)

UserName

The (updated) short description of the user, often the users or automated systems name

Resource

/nexfsconsoleapi

RequestId

A requestid number that identifies the request made against the management api

Errors

Also See Rest Error Responses

400 BadRequest The request was Malformed

A BadRequest will be returned if AssumeRolePolicyDocument, RoleName or Version is missing from the request

A BadRequest will also be returned if AssumeRolePolicyDocument is incorrectly formatted

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

500 InternalServerError An Internal Error was encountered

507 ToManyRoles Request exceed max roles allow for a user

Example Request

The following example updated a user with the attributes

Action: UpdateUser

Description: {

"UserDescription2": "of updating a user"

}

Email: exampleuserupdated@nexfs.net

NewContentSecret: SecretKey

NewSecretHash: 9f94debc27074c380d3028c52705e891

NewUserId: ExampleUserUpdated

UserId: ExampleUser

UserName: Example User Updated

GET http://nexfs.example.com:9200/nexfsconsoleapi?Action=UpdateUser&Description={%20%22UserDescription2%22:%20%22of%20updating%20a%20user%22}&Email=exampleuserupdated@nexfs.net&NewContentSecret=SecretKey&NewSecretHash=9f94debc27074c380d3028c52705e891&NewUserId=ExampleUserUpdated&UserId=ExampleUser&UserName=Example%20User%20Updated

Authorization: AWS4-HMAC-SHA256 Credential=50227ccc27f548539223d214d354acc7/20220831/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=274dcce53dcd387ff2a2df8b67e186649750b4b5050900881627d0da41eda130

host: nexfs.example.com

x-amz-date: 20220831T141345Z

Example Response

<?xml version="1.0" encoding="UTF-8"?>

<RequestCompleted>

<Code>Ok</Code>

<UpdateUserResponse>

<UpdateUserResult>

<User>

<UserName>Example User Updated</UserName>

<UserId>ExampleUserUpdated</UserId>

</User>

</UpdateUserResult>

<ResponseMetadata>

<RequestId>75</RequestId>

</ResponseMetadata>

</UpdateUserResponse>

<Resource>/nexfsconsoleapi</Resource>

</RequestCompleted>