Nexfs Management API Documentation

Method Index

GetUser

Retrieve User account details using the Nexfs Management API


Action: GetUser

Retrieve the details of a existing Nexfs Management User.


Permissions

The requesting session must have the iam/GetUser role enabled.


Request Parameters

A request must be made against the nexfs management console api with the GetUser Action.

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


Action

GetUser


UserId

The User Id to retrieve details of

Request Body

The request does not have a request body.


Response Syntax


HTTP1/1 200

<RequestCompleted>

<Code>string</Code>

<GetUserResponse>

<GetUserResult>

<User>

<UserId>string</UserId>

<UserName>string</UserName>

<UserEnabled>integer</UserEnabled>

<UserEmail>string</UserEmail>

<UserDescription1>string</UserDescription1>

<UserDescription2>string</UserDescription2>

<AuthenicationMethod>integer</AuthenicationMethod>

<Roles>

<Role>string</Role>

...

</Roles>

</User>

</GetUserResult>

<ResponseMetadata>

<RequestId>integer</RequestId>

</ResponseMetadata>

</GetUserResponse>

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


Code

OK


GetUserResponse

Tag marking the start of the Get User response


GetUserResults

Tag marking the start of the Get User results


User

Container Tag marking the start of the user details


UserId

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


UserName

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


UserEnabled

0 if the user account is disabled,

1 if the account is active/enabled


UserEmail

The users email address (if perviously saved)

UserDescription1

Optional text describing the account


UserDescription2

Optional additional text describing the account


AuthenicationMethod

0 = Authenticated by Nexfs


Roles

Array Tag marking the start of a list of zero or more Roles assigned the the user

Role

The name corresponding to a role the users has assigned


Resource

/nexfsconsoleapi


ResponseMetadata

Tag marking the start of the response metadata

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

UserId is missing from the 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


Example Request


GET http://nexfs.example.com/nexfsconsoleapi?Action=GetUser&UserId=operator

Authorization: AWS4-HMAC-SHA256 Credential=df32f3e98119468da88ee9841bee0288/20220906/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=b699f1d44fa7092bfc6fca4d8c9c24ac76a68f1caefb37bc4f529deec3d993fd

content-type: application/x-www-form-urlencoded; charset=utf-8

host: nexfs.example.com

x-amz-date: 20220906T205711Z


Example Response


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

<RequestCompleted>

<Code>Ok</Code>

<GetUserResponse>

<GetUserResult>

<User>

<UserId>operator</UserId>

<UserName>operator account</UserName>

<UserEnabled>1</UserEnabled>

<UserEmail>ops@nexfs.net</UserEmail>

<UserDescription1>operator monitoring account</UserDescription1>

<UserDescription2>ops department</UserDescription2>

<AuthenicationMethod>0</AuthenicationMethod>

<Roles>

<Role>Nexfs Operator Role</Role>

</Roles>

</User>

</GetUserResult>

<ResponseMetadata>

<RequestId>35</RequestId>

</ResponseMetadata>

</GetUserResponse>

<Resource>/nexfsconsoleapi</Resource>

</RequestCompleted>