文档

ListOrganizationalUnits - 列表查询EIAM组织信息

分页查询EIAM组织信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eiam:ListOrganizationalUnitsRead
  • 全部资源
    acs:eiam:{#regionId}:{#accountId}:*

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumberlong

列表页码,默认 1。

1
PageSizelong

列表大小,默认 20,最大不超过 100。

20
OrganizationalUnitIdsarray

组织 ID 列表,列表元素数量最多不超过 100。

string

组织 ID。

ou_wovwffm62xifdziem7an7xxxxx
OrganizationalUnitNamestring

组织名称,查询为精确匹配查询。

name_001
OrganizationalUnitNameStartsWithstring

组织名称前缀,查询为左匹配查询。

name
ParentIdstring

父组织 ID。

ou_wovwffm62xifdziem7an7xxxxx

返回参数

名称类型描述示例值
object

响应结果。

RequestIdstring

请求 ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCountlong

数据总条数目,为匹配到的总数量,单次返回最大数量以 pageSize 为准。

1000
OrganizationalUnitsobject []

组织数据列表。

OrganizationalUnitIdstring

组织 ID。

ou_wovwffm62xifdziem7an7xxxxx
OrganizationalUnitNamestring

组织名称。

test_organizationalUnit_name
ParentIdstring

父组织 ID。

ou_wovwffm62xifdziem7an7xxxxx
OrganizationalUnitExternalIdstring

组织外部 ID,用于外部数据与 IDaaS 组织的数据关联映射,默认为 IDaaS 组织 ID。

说明:外部 ID 在同一来源类型和来源 ID 下唯一。

ou_wovwffm62xifdziem7an7xxxxx
OrganizationalUnitSourceTypestring

组织来源类型,取值可选范围:

  • build_in:自建。
  • ding_talk:钉钉导入。
  • ad:AD 导入。
  • ldap:LDAP 导入。
  • we_com:企业微信导入。
build_in
OrganizationalUnitSourceIdstring

组织来源 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
CreateTimelong

组织创建时间,格式为 Unix 时间戳,单位为毫秒。

1652085686179
UpdateTimelong

组织最近一次更新时间,格式为 Unix 时间戳,单位为毫秒。

1652085686179
Descriptionstring

组织描述。

测试组织
InstanceIdstring

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
Leafboolean

是否叶子节点,true 表示该组织没有子节点,false 表示该组织下存在子节点。

false

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 1000,
  "OrganizationalUnits": [
    {
      "OrganizationalUnitId": "ou_wovwffm62xifdziem7an7xxxxx",
      "OrganizationalUnitName": "test_organizationalUnit_name",
      "ParentId": "ou_wovwffm62xifdziem7an7xxxxx",
      "OrganizationalUnitExternalId": "ou_wovwffm62xifdziem7an7xxxxx",
      "OrganizationalUnitSourceType": "build_in",
      "OrganizationalUnitSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "CreateTime": 1652085686179,
      "UpdateTime": 1652085686179,
      "Description": "测试组织",
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "Leaf": false
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-06-21OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:OrganizationalUnitIds
出参OpenAPI 返回结构发生变更
2023-04-04OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-21OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:OrganizationalUnitNameStartsWith
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈