ListSCIMGroups - 查询 SCIM 组列表

更新时间:
复制 MD 格式

适用版本

中心版、Region版

服务接入点与授权信息

产品

资源

所需权限

组织管理

SCIM

只读

请求语法

中心版

GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/scim/v2/Groups

Region版

GET https://{domain}/oapi/v1/platform/scim/v2/Groups

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

是

个人访问令牌。

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

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

  • 是:中心版

  • 否:Region版

组织 ID。

filter

string

query

否

SCIM filter 表达式,MVP 支持 eq 与 and。

startIndex

integer

query

否

SCIM 起始下标,从 1 开始。

count

integer

query

否

每页数量。

请求示例

中心版

curl -X 'GET' \
  'https://{domain}/oapi/v1/platform/organizations/{organizationId}/scim/v2/Groups?filter={filter}&startIndex={startIndex}&count={count}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Region版

curl -X 'GET' \
  'https://{domain}/oapi/v1/platform/scim/v2/Groups?filter={filter}&startIndex={startIndex}&count={count}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数

类型

描述

示例值

-

object

Resources

array

-

object

itemsPerPage

integer

schemas

array[string]

startIndex

integer

totalResults

integer

返回示例

{
    "Resources": [
        {
        }
    ],
    "itemsPerPage": 0,
    "schemas": [
        
    ],
    "startIndex": 0,
    "totalResults": 0
}

错误码

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