Nexfs Management API Documentation

Method Index

ListRoles

List Nexfs Roles using the Nexfs Management API


Action: ListRoles

Retrieve a list of Nexfs Management Roles .


Permissions

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


Request Parameters

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

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


Action

ListRoles

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>

<ListRolesResponse>

<ListRolesResults>

<IsTruncated>string</IsTruncated>

<Roles>

<member>

<RoleId>integer</RoleId>

<RoleName>string</RoleName>

<RoleEnabled>integer</RoleEnabled>

<RoleVersion>string</RoleVersion>

</member>

...

</Roles>

</ListRolesResults>

<ResponseMetadata>

<RequestId>integer</RequestId>

</ResponseMetadata>

</ListRolesResponse>

<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

ListRolesResponse

Tag marking the start of the List Roles response


ListRolesResults

Tag marking the start of the List Roles results


IsTruncated

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


Roles

Array Tag marking the start of the roles listing

member

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


RoleId

The Role Id

RoleName

A short description of the Role


RoleEnabled

0 if the Role is disabled,

1 if the Role is active/enabled


RoleVersion

The version attached to the role when it was created or last updated


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=ListRoles

Authorization: AWS4-HMAC-SHA256 Credential=82fc40276f4b46a99a47386374a873c9/20220831/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=a27b8d4d85348a7de0d9cb2c0801e40a66857a08243ba9c9d914f8e217c9ec09

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

host: nexfs.example.com

x-amz-date: 20220831T110242Z

Example Response


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

<RequestCompleted>

<Code>Ok</Code>

<ListRolesResponse>

<ListRolesResults>

<IsTruncated>false</IsTruncated>

<Roles>

<member>

<RoleId>50000</RoleId>

<RoleName>Nexfs Default Administration Role</RoleName>

<RoleEnabled>1</RoleEnabled>

<RoleVersion></RoleVersion>

</member>

<member>

<RoleId>50001</RoleId>

<RoleName>Example Role Update</RoleName>

<RoleEnabled>0</RoleEnabled>

<RoleVersion></RoleVersion>

</member>

</Roles>

</ListRolesResults>

<ResponseMetadata>

<RequestId>25</RequestId>

</ResponseMetadata>

</ListRolesResponse>

<Resource>/nexfsconsoleapi</Resource>

</RequestCompleted>