PUT ユーザー API

動作方法

PUT メソッドを使用して既存のユーザーを置き換えます：

PUT /scim/v2/Users/{id}

認証

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

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

PUT 操作のパラメータ

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

オブジェクト	タイプ	必須	説明
`id`	URLパラメータ	必須	ユーザーの一意の識別子。この値は REST API 呼び出しの一部として送信されます。
`userName`	オブジェクト	必須	ユーザーのユーザー名（メールアドレス形式）。これは有効なメールアドレスでなければなりません。API を通じて `userName` を変更することはできません。
`name`	オブジェクト	任意	ユーザーの名前を含むリスト。各名前には `givenName` と `familyName` を含むことができます。Null および空の値が許可されます。
`emails`	配列	任意	この値は `userName` によって自動的に構成されます。
`active`	ブール値	任意	ユーザーがアクティブかどうかを示します。ユーザーを削除または非アクティブ化しようとする場合は、DELETE メソッドを使用するか、PATCH メソッドを使用して `active` 値を `false` に変更してください。

cURL リクエストの例

curl -X PUT "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": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "userName": "updated.user@example.com",
  "name": {
    "givenName": "Updated",
    "familyName": "User"
  },
  "emails": [{
    "value": "updated.user@example.com"
  }],
  "active": true
}'

応答の例

コードスニペットを表示するには展開してください

エラーメッセージ

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

エラーコード	エラーメッセージ
400	`{"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],"status": "400","scimType": "invalidValue","detail": "userName must be a valid email address."`
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}."}`
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, PUT, DELETE."}`
500	`{"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],"status": "500","scimType": "internalServerError","detail": "Error processing json for extension - account {ACCOUNT}"}`