メインコンテンツまでスキップ

List Group Members (V2)

Lists the members of a SCIM group.

GET/v2/groups/{groupId}/members
接続エンドポイント

https://api.cloud.zilliz.com

shell
export BASE_URL="https://api.cloud.zilliz.com"
パラメータ
Authorizationstringheader必要

認証トークンは、適切な権限を持つ API キーである必要があります。

値の例： Bearer {{TOKEN}}
groupIdstringpath必要

SCIM グループ ID。

値の例： g-xxxxxxxxxxxxxx
currentPageintegerquery

返すページ番号。最初のページは 1 です。

値の例： 1
pageSizeintegerquery

1 ページあたりに返す項目数。

値の例： 10
bash
export TOKEN="YOUR_API_KEY"
export groupId="g-xxxxxxxxxxxxxx"

curl --request GET \
--url "${BASE_URL}/v2/groups/${groupId}/members" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"
レスポンス200 OK - application/json

成功した結果またはエラーメッセージを返します。

成功したレスポンス。

codeinteger必要

レスポンスコード。

値の例： 0
dataobject必要
countinteger必要

一致する項目の総数。

currentPageinteger必要

現在のページ番号。

値の範囲： ≥ 1
pageSizeinteger必要

要求されたページサイズ。

値の範囲： ≥ 1
membersarray必要

このページで返されたメンバー。

[]membersobject必要
usernamestring必要

メンバーの表示名。

emailstring<email>必要

メンバーのメールアドレス。

失敗したレスポンス。

codeinteger必要

レスポンスコード。

messagestring必要

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {
        "count": 12,
        "currentPage": 1,
        "pageSize": 10,
        "members": [
            {
                "username": "Alice",
                "email": "alice@example.com"
            },
            {
                "username": "Bob",
                "email": "bob@example.com"
            }
        ]
    }
}
Ctrl I