ListRoles (GET)
  • 17 Sep 2026
  • Dark
    Light

ListRoles (GET)

  • Dark
    Light

Article summary

Get
/#/ListRoles

Availability

Early Access: July 1, 2026

Early Access is gated; contact the Backblaze Sales team for access.

Limited Availability: July 1, 2026

This API is available only to customers with access to the Backblaze Enterprise Web Console. For more information, contact the Backblaze Sales team.

List roles in the account

Actual request: GET /?Action=ListRoles&Version=2010-05-08&... to iam.backblazeb2.com.

Request parameters

ParameterTypeRequiredDescription
ActionstringyesListRoles
Versionstringyes2010-05-08
PathPrefixstringnoFilter by path prefix.
MarkerstringnoPagination marker.
MaxItemsintegernoMaximum number of roles to return (up to 1,000).

Example response

 <ListRolesResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
  <ListRolesResult>
    <Roles>
      <member>
        <Path>/service/</Path>
        <RoleName>analytics-role</RoleName>
        <RoleId>AROAEXAMPLE123456789</RoleId>
        <Arn>arn:aws:iam::123456789012:role/service/analytics-role</Arn>
        <CreateDate>2026-02-03T21:10:00Z</CreateDate>
      </member>
    </Roles>
    <IsTruncated>false</IsTruncated>
  </ListRolesResult>
  <ResponseMetadata>
    <RequestId>req-1234567890</RequestId>
  </ResponseMetadata>
</ListRolesResponse> 
Security
API Key: sigv4
Header parameter nameAuthorization

AWS Signature Version 4. The Authorization header takes the form AWS4-HMAC-SHA256 Credential=..., SignedHeaders=..., Signature=.... For IAM and STS requests, the signing region is not validated; use any non-empty region value consistently. The signing service must be iam for IAM requests and sts for STS requests. When using temporary credentials, also include X-Amz-Security-Token: <session-token>.

Query parameters
Action
stringRequired

API operation name.

Version
stringRequired

IAM API version.

Valid values[ "2010-05-08" ]
Default"2010-05-08"
PathPrefix
string

Filter results by path prefix.

Example/service/
Marker
string

Pagination marker returned by a previous list response.

MaxItems
integer

Maximum number of items to return. Maximum 1,000.

Minimum1
Maximum1000
Responses
200

The request succeeded. The response body is an XML document specific to the Action invoked, with a ResponseMetadata block containing a RequestId.

string

Action-specific XML response. See the example response for each operation.

400

The request was malformed or failed validation.

HTTP StatusCodeDescription
400ValidationErrorInvalid input parameter or failed validation.
string
403

The caller is not authorized. For operations that reference IAM resources, authorization may be evaluated before resource existence is disclosed.

HTTP StatusCodeDescription
403AccessDeniedThe authenticated principal lacks permission for this action.
string
429

The request was rate-limited.

HTTP StatusCodeDescription
429ThrottlingToo many requests. Use exponential backoff.
string
500

The server encountered an unexpected condition.

HTTP StatusCodeDescription
500InternalFailureUnexpected server error.
string

Was this article helpful?