Retrieve a details of Content Roles from the Nexfs Management API

Action: GetContentRoles

Request details of Content Roles (S3 User Roles)

Permissions

To retrieve a list of and the details of content roles a requesting session must have the nexfs/GetContentRoles role enabled.

Request Parameters

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

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

Action

GetContentRoles

Request Body

The request does not have a request body.

Response Syntax

HTTP1/1 200

{

"Roles": [

{

"RoleName": "string",

"RoleId": integer,

"Enabled": integer,

"Policy": {

"Version": "string",

"Statement": [

{

"Sid": "string",

"Effect": "string",

"Action": [

"string"

]

}]

}

}]

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in json format by the service:

Roles

A json array with contains zero or more content role json objects

Rolename

The Name of the Role

RoleId

The role Id

Enabled

0 - Role is Disabled,

1 - Role is enabled

Policy

A json object with contains the policy attached to the role

Version

A version of the Policy

Statement

A json object with contains the roles policy statement

Sid

A string label the represents the statement

Effect

"Allow" or "Deny"

Action

A json array with contains zero or more management role permissions

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

500 InternalServerError An Internal Error was encountered

Example Request

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

Authorization: AWS4-HMAC-SHA256 Credential=20632615afb54ceda562c02aa9142a90/20220829/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=bae8634f1000719732f8003b52f4b1d1614c59177f612afff62f3aad02651e3f

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

host: nexfs.example.com

x-amz-date: 20220829T124258Z

Example Response

HTTP1/1 200

{

"Roles": [

{

"RoleName": "Nexfs Default Allow All User Role",

"RoleId": 70000,

"Enabled": 1,

"Policy": {

"Version": "26/10/2022.0",

"Statement": [{

"Sid": "Nexfs Default Allow All User Policy",

"Effect": "Allow",

"Action": ["*:*"]

}]

}

}]

}