doc-exports/docs/iam/api-ref/en-us_topic_0057845591.html

Querying a Role List

Function

This API is used to query a role list, including the permissions policies of a role. A role is a set of permissions and represents a group of actions.

URI

GET /v3/roles

Table 1 Query parameters

Parameter	Mandatory	Type	Description
domain_id	No	String	Domain ID. NOTE: If this parameter is specified, only custom policies of the account will be returned. If this parameter is not specified, all system permissions (including system-defined policies and roles) will be returned.
name	No	String	Permission name for internal use. It may be different from the display_name displayed on the console.

Request Parameters

Table 2 Parameters in the request header

Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Fill application/json;charset=utf8 in this field.
X-Auth-Token	Yes	String	Token with Security Administrator permissions.

Response Parameters

Table 3 Parameters in the response body

Parameter	Type	Description
links	Object	Resource link information.
roles	Array of objects	Permission information.
total_number	Integer	Total number of permissions.

Table 4 links

Parameter	Type	Description
self	String	Resource link.
previous	String	Previous resource link.
next	String	Next resource link.

Table 5 roles

Parameter	Type	Description
domain_id	String	ID of the domain to which the permission belongs.
flag	String	If this parameter is set to fine_grained, the permission is a system-defined policy.
description_cn	String	Description of the permission in Chinese.
catalog	String	Service catalog of the permission.
name	String	Permission name. This parameter is carried in the token of a user. The cloud service determines whether the user has the access permission based on the role name.
description	String	Description of the permission.
links	Object	Permission resource link.
id	String	Permission ID.
display_name	String	Display name of the permission.
type	String	Display mode of the permission. NOTE: AX: Account level. XA: Project level. AA: Both the account level and project level. XX: Neither the account level nor project level. The display mode of a custom policy can only be AX or XA. A custom policy must be displayed at either of the two levels.
policy	Object	Content of the permission.
updated_time	String	Time when the permission was last updated.
created_time	String	Time when the permission was created.

Table 6 roles.links

Parameter	Type	Description
self	String	Resource link.
previous	String	Previous resource link.
next	String	Next resource link.

Table 7 roles.policy

Parameter	Type	Description
Depends	Array of objects	Dependency permissions.
Statement	Array of objects	Statement of the permission.
Version	String	Permission version. NOTE: 1.0: System-defined role. Only a limited number of service-level roles are provided for authorization. 1.1: Policy. A policy defines the permissions required to perform operations on a specific cloud resource under certain conditions.

Table 8 roles.policy.Depends

Parameter	Type	Description
catalog	String	Service catalog of the permission.
display_name	String	Display name of the permission.

Table 9 roles.policy.Statement

Parameter	Type	Description
Action	Array of strings	Specific operation permission on a resource. NOTE: The value format is Service name:Resource type:Operation, for example, vpc:ports:create. Service name: indicates the product name, such as ecs, evs, or vpc. Only lowercase letters are allowed. Resource types and operations are not case-sensitive. You can use an asterisk (*) to represent all operations. For a custom agency policy, this parameter should be set to "Action": ["iam:agencies:assume"].
Effect	String	Effect of the permission. The value can be Allow or Deny. If both Allow and Deny statements are found in a policy, the authentication starts from the Deny statements. Options: Allow Deny
Condition	Object	Conditions for the permission to take effect.
Resource	Object	Cloud resource. NOTE: Format: ::::. For example, obs::🪣*. Asterisks are allowed. The region segment can be * or a region accessible to the user. The specified resource must belong to the corresponding service that actually exists. In the case of a custom policy for agencies, the type of this parameter is object, and the value should be set to "Resource": {"uri": ["/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c"]}.

Example Request

GET https://sample.domain.com/v3/roles

Example Response

Status code: 200

The request is successful.

{
  "roles" : [ {
    "domain_id" : null,
    "description_cn" : "Description of the permission in Chinese", 
    "catalog" : "VulnScan",
    "name" : "wscn_adm",
    "description" : "Vulnerability Scan Service administrator of tasks and reports.",
    "links" : {
      "next" : null,
      "previous" : null,
      "self" : "https://sample.domain.com/v3/roles/0af84c1502f447fa9c2fa18083fbb..."
    },
    "id" : "0af84c1502f447fa9c2fa18083fbb...",
    "display_name" : "VSS Administrator",
    "type" : "XA",
    "policy" : {
      "Version" : "1.0",
      "Statement" : [ {
        "Action" : [ "WebScan:*:*" ],
        "Effect" : "Allow"
      } ],
      "Depends" : [ {
        "catalog" : "BASE",
        "display_name" : "Server Administrator"
      }, {
        "catalog" : "BASE",
        "display_name" : "Tenant Guest"
      } ]
    }
  }, {
    "domain_id" : null,
    "flag" : "fine_grained",
    "description_cn" : "Description of the permission in Chinese", 
    "catalog" : "CSE",
    "name" : "system_all_34",
    "description" : "All permissions of CSE service.",
    "links" : {
      "next" : null,
      "previous" : null,
      "self" : "https://sample.domain.com/v3/roles/0b5ea44ebdc64a24a9c372b2317f7..."
    },
    "id" : "0b5ea44ebdc64a24a9c372b2317f7...",
    "display_name" : "CSE Admin",
    "type" : "XA",
    "policy" : {
      "Version" : "1.1",
      "Statement" : [ {
        "Action" : [ "cse:*:*", "ecs:*:*", "evs:*:*", "vpc:*:*" ],
        "Effect" : "Allow"
      } ]
    }
  } ],
  "links" : {
    "next" : null,
    "previous" : null,
    "self" : "https://sample.domain.com/v3/roles"
  },
  "total_number" : 300
}

Status Codes

Status Code	Description
200	The request is successful.
400	The server failed to process the request.
401	Authentication failed.
403	Access denied.

Parent topic: Permission Management