All Products
Search
Document Center

:ListUserRoles

Last Updated:May 20, 2024

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /api/metastore/auth/roles/userroles

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizeintegerNo

PageSize

-1/100
RoleNamePatternstringNo

role name pattern filter

.*test.*

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

RequestId

B7F4B621-E41E-4C84-B97F-42B5380A32BB
Codestring

Code

OK
Messagestring

Message

.
Successboolean

success

true
UserRolesUserRoles

UserRoles

NextPageTokenstring

NextPageToken

2cb472ec1bf84f8d92f9c4baa0d21c19aa

Examples

Sample success responses

JSONformat

{
  "RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
  "Code": "OK",
  "Message": ".",
  "Success": true,
  "UserRoles": [
    {
      "Role": {
        "Name": "role_name",
        "Description": "role description",
        "Users": [
          {
            "PrincipalArn": "acs:ram::[AliyunAccountId]:user/username_abc"
          }
        ],
        "DisplayName": "显示名称,允许中文",
        "PrincipalArn": "acs:dlf::111:role/role_name",
        "CreateTime": 1647323053,
        "UpdateTime": 1647323053,
        "IsPredefined": 1
      },
      "GrantTime": 0,
      "User": {
        "PrincipalArn": "acs:ram::[AliyunAccountId]:user/username_abc"
      }
    }
  ],
  "NextPageToken": "2cb472ec1bf84f8d92f9c4baa0d21c19aa"
}

Error codes

For a list of error codes, visit the Service error codes.