PATCH ユーザー API

動作原理

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

PATCH /scim/v2/Users/{id}

認証

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

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

PATCH 操作パラメータ

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

オブジェクト	タイプ	必須	説明
`id`	URLパラメータ	必須	ユーザーの一意の識別子。この値は REST API 呼び出しの一部として送信されます。
`op`	文字列	任意	実行する操作。サポートされる値は `Add`、`Replace`、`Remove` です。
`active`	ブール値	任意	ユーザーがアクティブかどうか。このパラメータは削除できません。`false` に構成するには `Replace` 操作を使用します。
`displayName`	文字列	任意	ユーザーの表示名。
`externalId`	文字列	任意	ユーザーの外部 ID。
`name.givenName`	文字列	任意	ユーザーの名。
`name.familyName`	文字列	任意	ユーザーの姓。

userName は不変であり、変更することはできません。

例 cURL リクエスト

curl -X PATCH "https://api.tealiumiq.com/scim/v2/Users/eb987394-b2b0-4a21-a1d8-7915a91e06b" \
-H "Content-Type: application/scim+json" \
-H "Accept: application/scim+json" \
-d '{
  "schemas": ["ietf:params:scim:api:messages:2.0:PatchOp"],
  "op": "Replace",
  "displayName": "updated.user@example.com",
  "externalId": "updated.user@example.com",
  "name": {
    "givenName": "Updated",
    "familyName": "User"
  },
  "active": true
}'

例応答

この呼び出しは 204 ステータスコードを返します。

エラーメッセージ

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

エラーコード	エラーメッセージ
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": "User not found in account {ACCOUNT}."}`
500	`{"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],"status": "500","scimType": "internalServerError","detail": "Error processing json for extension - account {ACCOUNT}"}`