更新时间:2024-04-10 GMT+08:00

查询服务提供商配置

功能介绍

查询IAM身份中心的SCIM相关配置信息。

URI

GET /{tenant_id}/scim/v2/ServiceProviderConfig

表1 路径参数

参数

是否必选

参数类型

描述

tenant_id

String

租户的全局唯一标识符(ID)。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

承载令牌。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

schemas

Array of strings

概要。

documentationUri

String

帮助文档链接。

authenticationSchemes

Array of objects

认证概要列表。

patch

Object

表示服务提供商是否支持部分修改操作,及对部分修改操作的相关配置。

bulk

Object

表示服务提供商是否支持批量操作,及对批量操作的相关配置。

filter

Object

表示服务提供商是否支持过滤操作,及对过滤操作的相关配置。

changePassword

Object

表示服务提供商是否支持修改密码操作,及对修改密码操作的相关配置。

sort

Object

表示服务提供商是否支持排序操作,及对排序操作的相关配置。

etag

Object

表示服务提供商是否支持电子标签,及对电子标签的相关配置。

表4 authenticationSchemes

参数

参数类型

描述

type

String

认证类型,指定鉴权的方式。

name

String

认证概要名称。

description

String

认证概要的描述信息。

specUri

String

规范链接。

documentationUri

String

帮助文档链接。

primary

Boolean

是否为主要的认证方式。

表5 patch

参数

参数类型

描述

supported

Boolean

一个布尔值,表示服务提供商是否支持这种操作。

表6 bulk

参数

参数类型

描述

supported

Boolean

一个布尔值,表示服务提供商是否支持这种操作。

maxOperations

Integer

一次可操作的最大个数。

maxPayloadSize

Integer

最大有效载荷量。

表7 filter

参数

参数类型

描述

supported

Boolean

一个布尔值,表示服务提供商是否支持这种操作。

maxResults

Integer

最大结果数。

表8 changePassword

参数

参数类型

描述

supported

Boolean

一个布尔值,表示服务提供商是否支持这种操作。

表9 sort

参数

参数类型

描述

supported

Boolean

一个布尔值,表示服务提供商是否支持这种操作。

表10 etag

参数

参数类型

描述

supported

Boolean

一个布尔值,表示服务提供商是否支持这种操作。

状态码: 400

表11 响应Body参数

参数

参数类型

描述

schema

String

概要。

schemas

Array of strings

概要列表。

detail

String

异常详情。

status

Integer

状态码。

timeStamp

String

时间戳。

状态码: 403

表12 响应Body参数

参数

参数类型

描述

schema

String

概要。

schemas

Array of strings

概要列表。

detail

String

异常详情。

status

Integer

状态码。

timeStamp

String

时间戳。

状态码: 404

表13 响应Body参数

参数

参数类型

描述

schema

String

概要。

schemas

Array of strings

概要列表。

detail

String

异常详情。

status

Integer

状态码。

timeStamp

String

时间戳。

状态码: 409

表14 响应Body参数

参数

参数类型

描述

schema

String

概要。

schemas

Array of strings

概要列表。

detail

String

异常详情。

status

Integer

状态码。

timeStamp

String

时间戳。

状态码: 500

表15 响应Body参数

参数

参数类型

描述

schema

String

概要。

schemas

Array of strings

概要列表。

detail

String

异常详情。

status

Integer

状态码。

timeStamp

String

时间戳。

请求示例

查询IAM身份中心的SCIM相关配置信息。

GET https://{hostname}/{tenant_id}/scim/v2/ServiceProviderConfig

响应示例

状态码: 200

Successful

{
  "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig" ],
  "documentationUri" : null,
  "authenticationSchemes" : [ {
    "type" : "authenticationtype",
    "name" : "Authentication Name",
    "description" : "Authentication scheme using the AAA Authentication Standard",
    "specUri" : "http://www.example.org/doc/auth1234",
    "documentationUri" : null,
    "primary" : true
  } ],
  "patch" : {
    "supported" : false
  },
  "bulk" : {
    "supported" : false,
    "maxOperations" : null,
    "maxPayloadSize" : null
  },
  "filter" : {
    "supported" : false,
    "maxResults" : null
  },
  "changePassword" : {
    "supported" : false
  },
  "sort" : {
    "supported" : false
  },
  "etag" : {
    "supported" : false
  }
}

状态码

请参见状态码

错误码

请参见错误码