PATCH グループ API

動作方法

既存のグループを更新するには、PATCH メソッドを使用します：

PATCH /scim/v2/Groups/{id}

認証

すべての API 呼び出しには OAuth ベアラートークンが使用され、API キーは使用されません。

詳細については、認証を参照してください。

PATCH 操作のパラメータ

このコマンドは以下のパラメータを取ります：

オブジェクト	タイプ	必須	説明
`id`	URLパラメータ	必須	ユーザーの一意の識別子。この値は REST API 呼び出しの一部として送信されます。
`op`	文字列	任意	実行する操作。サポートされる値は `add`、`replace`、`remove` です。
`path`	文字列	任意	操作の対象を指定する属性パス。省略された場合、操作はリソース全体に対して実行されます。
`value`	配列	任意	ユーザー ID の配列。

cURL リクエストの例

Microsoft Entra ID

curl -X PATCH "https://developer.tealiumapis.com/scim/v2/Groups/eb987394-b2b0-4a21-a1d8-7915a91e06b" \
-H "Content-Type: application/scim+json" \
-H "Accept: application/scim+json" \
-d '{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
        {
            "op": "replace",
            "path": "members",
            "value": [
               {
                   "value": "cb300cb6-9702-45a9-a909-f8b7c972ab7e"
               }
           ]
        }
    ]
}'

Okta

curl -X PATCH "https://developer.tealiumapis.com/scim/v2/Groups/eb987394-b2b0-4a21-a1d8-7915a91e06b" \
-H "Content-Type: application/scim+json" \
-H "Accept: application/scim+json" \
-d '{{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
        {
            "op": "replace",
            "value": {
                "members": [
                   {
                       "value": "cb300cb6-9702-45a9-a909-f8b7c972ab7e"
                   }
               ]
            }
        }
    ]
}'

応答の例

コードスニペットを表示するには展開

エラーメッセージ

このエンドポイントに関する潜在的なエラーメッセージ：

エラーコード	エラーメッセージ
400	`{"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],"status": "400","scimType": "invalidValue","detail": "User payload is required."`
401	`{"returnCode" : 1401 , "message" : "Authentication failed."}`
403	`{"schemas": [ "urn:ietf:params:scim:api:messages:2.0:Error"],"status": "403","scimType": null,"detail": "Missing X-Tealium-Account header."}`
404	`{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status": "404", "scimType": "noTarget", "detail":"Group uuid 1987a965-411b-4816-b485-29fd81ca81ac not found in account testaccount"}`
405	`{"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"], "status": "405", "scimType": "invalidMethod", "detail": "Method is not allowed on this endpoint. Allowed methods: GET, POST."}`
500	`{"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],"status": "500","scimType": "internalServerError","detail": "Error processing json for extension - account {ACCOUNT}"}`
501	`{"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],"status": "501","scimType": "unsupported","detail": "The operation {operation} is not supported."}`