GetRole - 查询角色信息

通过 OpenAPI 查询角色信息。

适用版本

企业专属版、企业标准版

服务接入点与授权信息

请求语法

GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/roles/{id}

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

组织 ID。

99d1****71d4

id

string

path

角色 ID。

baef****accd

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/oapi/v1/platform/organizations/{organizationId}/roles/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数

类型

描述

示例值

-

object

id

string

角色 ID。

99d1****6124

name

string

角色名称。

示例名

organizationId

string

组织 ID。

99d1****6124

permissions

array[string]

角色权限列表。

[base******]

返回示例

{
    "id": "99d1****6124",
    "name": "示例名",
    "organizationId": "99d1****6124",
    "permissions": [base******]
}

错误码

访问错误码中心查看 API 相关错误码。