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

查询用户是否为用户组成员

功能介绍

根据用户ID和用户组ID列表,查询用户是否为用户组的成员。

URI

POST /v1/identity-stores/{identity_store_id}/is-member-in-groups

表1 路径参数

参数

是否必选

参数类型

描述

identity_store_id

String

身份源的全局唯一标识符(ID)。

最小长度:12

最大长度:12

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。

最大长度:2048

表3 请求Body参数

参数

是否必选

参数类型

描述

group_ids

Array of strings

用户组标识符列表。

最小长度:1

最大长度:47

数组长度:1-100

member_id

Object

包含组成员标识符的对象。

表4 member_id

参数

是否必选

参数类型

描述

user_id

String

身份源中IAM身份中心用户的全局唯一标识符(ID)。

最小长度:1

最大长度:47

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

results

Array of objects

成员是否在用户组内的结果列表。

数组长度:1-100

表6 results

参数

参数类型

描述

group_id

String

身份源中IAM身份中心用户组的全局唯一标识符(ID)。

最小长度:1

最大长度:47

member_id

Object

包含组成员标识符的对象。

membership_exists

Boolean

一个布尔值,表示用户是否在组中。

表7 results.member_id

参数

参数类型

描述

user_id

String

身份源中IAM身份中心用户的全局唯一标识符(ID)。

最小长度:1

最大长度:47

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

request_id

String

请求ID。

encoded_authorization_message

String

鉴权信息。

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

request_id

String

请求ID。

encoded_authorization_message

String

鉴权信息。

状态码: 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

request_id

String

请求ID。

encoded_authorization_message

String

鉴权信息。

请求示例

根据用户ID和用户组ID列表,查询用户是否为用户组的成员。

POST https://{hostname}/v1/identity-stores/{identity_store_id}/is-member-in-groups

{
  "group_ids" : [ "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a" ],
  "member_id" : {
    "user_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9"
  }
}

响应示例

状态码: 200

Successful

{
  "results" : [ {
    "group_id" : "0efaa0db-6aa4-7aaa-6aa5-c222aaaaf31a",
    "member_id" : {
      "user_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9"
    },
    "membership_exists" : true
  } ]
}

状态码

请参见状态码

错误码

请参见错误码