文档首页/ IAM 身份中心/ API参考/ API/ SCIM用户组管理/ 创建用户组
更新时间：2024-04-10 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建用户组

功能介绍

使用SCIM协议，同步用户组到IAM身份中心。

URI

POST /{tenant_id}/scim/v2/Groups

表1 路径参数

参数

是否必选

参数类型

描述

tenant_id

是

String

租户的全局唯一标识符（ID）。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

承载令牌。
表3 请求Body参数

参数

是否必选

参数类型

描述

externalId

否

String

外部标识符。

displayName

否

String

包含用户组显示名称的字符串。

members

否

Array of objects

用户组中的成员对象列表。

schemas

否

Array of strings

概要。
表4 members

参数

是否必选

参数类型

描述

value

是

String

成员的全局唯一标识符（ID）。

$ref

否

String

成员的引用信息。

type

否

String

成员类型，User：用户。

响应参数

状态码： 201

表5 响应Body参数

参数

参数类型

描述

id

String

用户组的全局唯一标识符（ID）。

externalId

String

外部标识符。

meta

Object

元数据。

schemas

Array of strings

概要。

displayName

String

包含用户组显示名称的字符串。

members

Array of objects

用户组中的成员对象列表。
表6 meta

参数

参数类型

描述

resourceType

String

资源类型。

created

String

资源创建时间。

lastModified

String

资源最后更新时间。
表7 members

参数

参数类型

描述

value

String

成员的全局唯一标识符（ID）。

$ref

String

成员的引用信息。

type

String

成员类型，User：用户。

状态码： 400

表8 响应Body参数

参数

参数类型

描述

schema

String

概要。

schemas

Array of strings

概要列表。

detail

String

异常详情。

status

Integer

状态码。

timeStamp

String

时间戳。

状态码： 403

表9 响应Body参数

参数

参数类型

描述

schema

String

概要。

schemas

Array of strings

概要列表。

detail

String

异常详情。

status

Integer

状态码。

timeStamp

String

时间戳。

状态码： 404

表10 响应Body参数

参数

参数类型

描述

schema

String

概要。

schemas

Array of strings

概要列表。

detail

String

异常详情。

status

Integer

状态码。

timeStamp

String

时间戳。

状态码： 409

表11 响应Body参数

参数

参数类型

描述

schema

String

概要。

schemas

Array of strings

概要列表。

detail

String

异常详情。

status

Integer

状态码。

timeStamp

String

时间戳。

状态码： 500

表12 响应Body参数

参数

参数类型

描述

schema

String

概要。

schemas

Array of strings

概要列表。

detail

String

异常详情。

status

Integer

状态码。

timeStamp

String

时间戳。

请求示例

创建用户组。

POST https://{hostname}/{tenant_id}/scim/v2/Groups

{
  "displayName" : "SCIM用户组名g1",
  "members" : [ {
    "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
    "$ref" : "../Users/ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
    "type" : "User"
  } ],
  "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:Group" ]
}

响应示例

状态码： 201

Successful

{
  "id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a",
  "meta" : {
    "resourceType" : "Group",
    "created" : "2023-04-08T14:53:43Z",
    "lastModified" : "2023-04-08T14:53:43Z"
  },
  "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:Group" ],
  "displayName" : "SCIM用户组名g1",
  "members" : [ {
    "value" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
    "$ref" : "../Users/ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
    "type" : "User"
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： SCIM用户组管理