Nexfs Management API Documentation

Method Index

ListUsers

List Nexfs Users using the Nexfs Management API

Action: ListUsers

Retrieve a list of Nexfs Management Users


Permissions

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

Request Parameters

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

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

Action

ListUsers


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>

<ListUsersResponse>

<ListUsersResults>

<IsTruncated>string</IsTruncated>

<Users>

<member>

<UserId>string</UserId>

<UserName>string</UserName>

<UserEnabled>integer</UserEnabled>

</member>

...

</Users>

</ListUsersResults>

<ResponseMetadata>

<RequestId>integer</RequestId>

</ResponseMetadata>

</ListUsersResponse>

<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

ListUsersResponse

Tag marking the start of the List Users response


ListUsersResults

Tag marking the start of the List Users results


IsTruncated

false, confirms that the complete list of roles has been returned


Users

Array Tag marking the start of the user listing


member

A tag marking the start of a user listing results, each user returned will be inclosed with its own member tag


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 is disabled,

1 if the User is active/enabled


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

401 Unauthorized The request cannot be authenticated

403 Forbidden Session does not have the rights to perform the requested action

Example Request


GET http://nexfs.example.com/nexfsconsoleapi?Action=ListUsers

Authorization: AWS4-HMAC-SHA256 Credential=027dcd1cad134782823b115d4efb00e5/20220831/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=1b299b191c60d83ba0cb625ec0ec41791c27aee12913b82428f8f4122f0679af

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

host: nexfs.example.com

x-amz-date: 20220831T135955Z

Example Response

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

<RequestCompleted>

<Code>Ok</Code>

<ListUsersResponse>

<ListUsersResults>

<IsTruncated>false</IsTruncated>

<Users>

<member>

<UserId>nexfsadmin</UserId>

<UserName>Nexfs Default Admin User</UserName>

<UserEnabled>1</UserEnabled>

</member>

<member>

<UserId>operator</UserId>

<UserName>operator</UserName>

<UserEnabled>1</UserEnabled>

</member>

<member>

<UserId>ExampleUser</UserId>

<UserName>Example User</UserName>

<UserEnabled>1</UserEnabled>

</member>

<member>

<UserId>anotheruser</UserId>

<UserName>another user</UserName>

<UserEnabled>1</UserEnabled>

</member>

<member>

<UserId>userseven</UserId>

<UserName>user number seven</UserName>

<UserEnabled>1</UserEnabled>

</member>

</Users>

</ListUsersResults>

<ResponseMetadata>

<RequestId>63</RequestId>

</ResponseMetadata>

</ListUsersResponse>

<Resource>/nexfsconsoleapi</Resource>

</RequestCompleted>