---
title: "Set SCIM information for a provisioned enterprise user"
method: PUT
path: "/scim/v2/Users/{scim_user_id}"
tags: ["enterprise-admin"]
---

# Set SCIM information for a provisioned enterprise user

`PUT /scim/v2/Users/{scim_user_id}`

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

Replaces an existing provisioned user's information.

You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead.

**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.

## Path parameters

- `scim_user_id` string, required

## Request body

- User
  - `schemas` string[], required — The URIs that are used to indicate the namespaces of the SCIM schemas.
  - `externalId` string, required — A unique identifier for the resource as defined by the provisioning client.
  - `active` boolean, required — Whether the user active in the IdP.
  - `userName` string, required — The username for the user.
  - `name` UserName
    - `formatted` string — The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.
    - `familyName` string, required — The family name of the user.
    - `givenName` string, required — The given name of the user.
    - `middleName` string — The middle name(s) of the user.
  - `displayName` string, required — A human-readable name for the user.
  - `emails` object[], required — The emails for the user.
    - `value` string, required — The email address.
    - `type` string, required — The type of email address.
    - `primary` boolean, required — Whether this email address is the primary address.
  - `roles` object[] — The roles assigned to the user.
    - `display` string
    - `type` string
    - `value` 'user' | '27d9891d-2c17-4f45-a262-781a0e55c80a' | 'guest_collaborator' | '1ebc4a02-e56c-43a6-92a5-02ee09b90824' | 'enterprise_owner' | '981df190-8801-4618-a08a-d91f6206c954' | 'ba4987ab-a1c3-412a-b58c-360fc407cb10' | 'billing_manager' | '0e338b8c-cc7f-498a-928d-ea3470d7e7e3' | 'e6be2762-e4ad-4108-b72d-1bbe884a0f91', required — The role value representing a user role in GitHub.
    - `primary` boolean — Is the role a primary role for the user.

## Response `200`

User was updated

## Other responses

- `400` — Bad request
- `401` — Authorization failure
- `403` — Permission denied
- `404` — Resource not found
- `409` — Duplicate record detected
- `429` — Too many requests
- `500` — Internal server error

---

[API](https://skmtc.net/github/apis/github-v3-rest-api-6.md) · [All operations](https://skmtc.net/github/apis/github-v3-rest-api-6/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/github/github-v3-rest-api-6/versions/15db3fa0759b/schema)