Update an attribute for a SCIM enterprise user

PATCH

/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}

Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.

Update a provisioned user's individual attributes.

To change a user's values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.

Note: Complicated SCIM path selectors that include filters are not supported. For example, a path selector defined as "path": "emails[type eq \"work\"]" will not work.

Warning: Setting active: false will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.

{
  "Operations":[{
    "op":"replace",
    "value":{
      "active":false
    }
  }]
}

リクエストパラメータ

パスパラメータ

リクエストボディパラメータapplication/json

例

レスポンス

🟢200OK

application/scim+json

Success, user was updated

ボディapplication/scim+json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409409

🟠429429

🔴500Server Error

リクエストExample

Shell

JavaScript

Java

Swift

cURL

Multi Valued PropertySingle Valued PropertyDisable User

curl --location --request PATCH 'https://service1.exmaple.com/scim/v2/enterprises//Users/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
        {
            "op": "replace",
            "path": "emails[type eq '\''work'\''].value",
            "value": "updatedEmail@microsoft.com"
        },
        {
            "op": "replace",
            "path": "name.familyName",
            "value": "updatedFamilyName"
        }
    ]
}'

レスポンスExample

200 - 例 1

{}

更新日時 2025-06-12 06:47:18

Set SCIM information for a provisioned enterprise user

Delete a SCIM user from an enterprise