Patch a User
PATCH/scim/v2/sso/:connection_name/Users/:id
Make a request to patch a user.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
OK
Response Headers
X-Request-Id
The unique identifier for the API request.
Bad Request
Response Headers
X-Request-Id
The unique identifier for the API request.
Unauthorized
Response Headers
X-Request-Id
The unique identifier for the API request.
WWW-Authenticate
The unique identifier for the API request.
Example:
Basic error="invalid_key", error_description="The API Key is invalid"Forbidden
Response Headers
X-Request-Id
The unique identifier for the API request.
Not Found
Response Headers
X-Request-Id
The unique identifier for the API request.
Rate Limit Exceeded
Response Headers
X-Request-Id
The unique identifier for the API request.
X-RateLimit-Limit
The maximum number of requests you're permitted to make per time period.
X-RateLimit-Remaining
The number of requests remaining in the current rate limit window.
X-RateLimit-Reset
The relative time in seconds until the current rate-limit window resets.
Important: This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues.
Retry-After
The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached.
Internal Server Error
Response Headers
X-Request-Id
The unique identifier for the API request.
OpenAPI definition (YAML)
paths:
/scim/v2/sso/{connection_name}/Users/{id}:
patch:
parameters:
- name: connection_name
in: path
required: true
schema:
type: string
description: The Connection Name
- name: id
in: path
required: true
schema:
type: string
description: The unique identifier for the users.
requestBody:
content:
application/scim+json:
schema:
allOf:
- type: object
description: 'SCIM Patch operation for making partial updates to user attributes.
Supports add, remove, and replace operations on specific user properties
without requiring a full user object update.
'
properties:
api_version:
type: string
enum:
- scim/v2
description: APIVersion defines the schema version of this representation of a resource.
readOnly: true
kind:
type: string
description: Kind defines the object this REST resource represents.
readOnly: true
enum:
- PatchOp
id:
description: ID is the "natural identifier" for an object within its scope/namespace;
it is normally unique across time but not space. That is, you can assume that the
ID will not be reclaimed and reused after an object is deleted ("time"); however,
it may collide with IDs for other object `kinds` or objects of the same `kind` within
a different scope/namespace ("space").
type: string
maxLength: 255
readOnly: true
example: dlz-f3a90de
metadata:
allOf:
- description: ObjectMeta is metadata that all persisted resources must have, which
includes all objects users must create.
required:
- self
properties:
self:
description: Self is a Uniform Resource Locator (URL) at which an object can
be addressed. This URL encodes the service location, API version, and other
particulars necessary to locate the resource at a point in time
type: string
format: uri
readOnly: true
example: https://api.confluent.cloud/v2/kafka-clusters/lkc-f3a90de
resource_name:
description: Resource Name is a Uniform Resource Identifier (URI) that is globally
unique across space and time. It is represented as a Confluent Resource Name
type: string
format: uri
readOnly: true
example: crn://confluent.cloud/kafka=lkc-f3a90de
created_at:
type: string
format: date-time
example: '2006-01-02T15:04:05-07:00'
readOnly: true
description: The date and time at which this object was created. It is represented
in RFC3339 format and is in UTC.
updated_at:
type: string
format: date-time
example: '2006-01-02T15:04:05-07:00'
readOnly: true
description: The date and time at which this object was last updated. It is
represented in RFC3339 format and is in UTC.
deleted_at:
type: string
format: date-time
example: '2006-01-02T15:04:05-07:00'
readOnly: true
description: The date and time at which this object was (or will be) deleted.
It is represented in RFC3339 format and is in UTC.
readOnly: true
title: ObjectMeta
- properties:
self:
example: https://api.confluent.cloud/scim/v2/patch-ops/po-12345
resource_name:
example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/patch-op=po-12345
schemas:
type: array
description: The SCIM schema.
items:
type: string
example: urn:ietf:params:scim:api:messages:2.0:PatchOp
Operations:
type: array
description: A list of patch operations.
items:
type: object
required:
- op
properties:
op:
type: string
description: The operation to perform.
enum:
- add
- remove
- replace
example: replace
path:
type: string
description: The attribute path describing the target of the operation.
example: active
value:
oneOf:
- type: string
- type: boolean
- type: object
- type: array
description: The value to be used within the operation.
example: false
title: scim.v2.PatchOp
- type: object
required:
- schemas
application/json:
schema:
type: object
description: 'SCIM Patch operation for making partial updates to user attributes.
Supports add, remove, and replace operations on specific user properties
without requiring a full user object update.
'
properties:
metadata:
allOf:
- description: ObjectMeta is metadata that all persisted resources must have, which
includes all objects users must create.
properties: {}
readOnly: true
title: ObjectMeta
- properties:
self:
example: https://api.confluent.cloud/scim/v2/patch-ops/po-12345
resource_name:
example: crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/patch-op=po-12345
schemas:
type: array
description: The SCIM schema.
items:
type: string
example: urn:ietf:params:scim:api:messages:2.0:PatchOp
Operations:
type: array
description: A list of patch operations.
items:
type: object
required:
- op
properties:
op:
type: string
description: The operation to perform.
enum:
- add
- remove
- replace
example: replace
path:
type: string
description: The attribute path describing the target of the operation.
example: active
value:
oneOf:
- type: string
- type: boolean
- type: object
- type: array
description: The value to be used within the operation.
example: false
title: scim.v2.PatchOp
x-lifecycle-stage: General Availability
x-self-access: true
x-name: scim.v2.Users
operationId: patchScimV2User
description: '[](#section/Versioning/API-Lifecycle-Policy)
Make a request to patch a user.'
tags:
- Users (scim/v2)
security:
- cloud-api-key: []
- confluent-sts-access-token: []
responses:
'200':
description: OK
x-minispec-transform-ignore: true
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
content:
application/scim+json:
schema:
type: object
description: 'Represents a user account in Confluent Cloud managed through SCIM protocol.
'
properties:
schemas:
type: array
description: The SCIM schema.
items:
type: string
example: urn:ietf:params:scim:schemas:core:2.0:User
id:
type: string
maxLength: 255
description: Unique identifier for the User. Automatically assigned by Confluent Cloud.
readOnly: true
example: u-12345
userName:
type: string
description: 'The user''s email address, which serves as their unique identifier in
Confluent Cloud.
'
example: marty.mcfly@example.com
name:
type: object
description: The user's full name.
allOf:
- description: The user's full name.
type: object
properties:
givenName:
type: string
description: The user's first name.
example: Marty
familyName:
type: string
description: The user's last name.
example: McFly
title: scim.v2.Name
active:
type: boolean
description: 'Indicates whether the user account is active and can access Confluent
Cloud resources.
'
example: true
meta:
type: object
description: Metadata about the resource.
readOnly: true
allOf:
- description: Metadata about the SCIM resource.
type: object
readOnly: true
properties:
resourceType:
type: string
description: The name of the resource type of the resource.
example: User
created:
type: string
format: date-time
description: The DateTime the Resource was added to Confluent Cloud.
example: '2025-01-01T12:00:00Z'
lastModified:
type: string
format: date-time
description: The most recent DateTime that the details of this Resource were
updated.
example: '2025-01-01T12:00:00Z'
location:
type: string
format: uri
description: The URI of the SCIM resource being returned.
example: https://api.confluent.cloud/scim/v2/Users/u-12345
title: scim.v2.Meta
title: scim.v2.User
'400':
description: Bad Request
x-minispec-transform-ignore: true
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
content:
application/scim+json:
schema:
type: object
description: 'Standard SCIM error response format containing error details and status
information.
Returned when SCIM operations encounter validation errors or other issues.
'
properties:
schemas:
type: array
description: The SCIM schema for the error response.
items:
type: string
example: urn:ietf:params:scim:api:messages:2.0:Error
status:
type: string
description: The HTTP status code of the error response.
detail:
type: string
description: A human-readable description of the error.
title: scim.v2.Error
example:
schemas:
- urn:ietf:params:scim:api:messages:2.0:Error
status: '400'
detail: Bad Request
'401':
description: Unauthorized
x-minispec-transform-ignore: true
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
WWW-Authenticate:
schema:
type: string
description: The unique identifier for the API request.
example: Basic error="invalid_key", error_description="The API Key is invalid"
content:
application/scim+json:
schema:
type: object
description: 'Standard SCIM error response format containing error details and status
information.
Returned when SCIM operations encounter validation errors or other issues.
'
properties:
schemas:
type: array
description: The SCIM schema for the error response.
items:
type: string
example: urn:ietf:params:scim:api:messages:2.0:Error
status:
type: string
description: The HTTP status code of the error response.
detail:
type: string
description: A human-readable description of the error.
title: scim.v2.Error
example:
schemas:
- urn:ietf:params:scim:api:messages:2.0:Error
status: '401'
detail: Unauthorized
'403':
description: Forbidden
x-minispec-transform-ignore: true
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
content:
application/scim+json:
schema:
type: object
description: 'Standard SCIM error response format containing error details and status
information.
Returned when SCIM operations encounter validation errors or other issues.
'
properties:
schemas:
type: array
description: The SCIM schema for the error response.
items:
type: string
example: urn:ietf:params:scim:api:messages:2.0:Error
status:
type: string
description: The HTTP status code of the error response.
detail:
type: string
description: A human-readable description of the error.
title: scim.v2.Error
example:
schemas:
- urn:ietf:params:scim:api:messages:2.0:Error
status: '403'
detail: Forbidden
'404':
description: Not Found
x-minispec-transform-ignore: true
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
content:
application/scim+json:
schema:
type: object
description: 'Standard SCIM error response format containing error details and status
information.
Returned when SCIM operations encounter validation errors or other issues.
'
properties:
schemas:
type: array
description: The SCIM schema for the error response.
items:
type: string
example: urn:ietf:params:scim:api:messages:2.0:Error
status:
type: string
description: The HTTP status code of the error response.
detail:
type: string
description: A human-readable description of the error.
title: scim.v2.Error
example:
schemas:
- urn:ietf:params:scim:api:messages:2.0:Error
status: '404'
detail: Not Found
'429':
description: Rate Limit Exceeded
x-minispec-transform-ignore: true
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
X-RateLimit-Limit:
schema:
type: integer
description: The maximum number of requests you're permitted to make per time period.
X-RateLimit-Remaining:
schema:
type: integer
description: The number of requests remaining in the current rate limit window.
X-RateLimit-Reset:
schema:
type: integer
description: "The relative time in seconds until the current rate-limit window resets. \
\ \n \n**Important:** This differs from Github and Twitter's same-named header which uses\
\ UTC epoch seconds. We use relative time to avoid client/server time synchronization\
\ issues."
Retry-After:
schema:
type: integer
description: The number of seconds to wait until the rate limit window resets. Only sent
when the rate limit is reached.
content:
application/scim+json:
schema:
type: object
description: 'Standard SCIM error response format containing error details and status
information.
Returned when SCIM operations encounter validation errors or other issues.
'
properties:
schemas:
type: array
description: The SCIM schema for the error response.
items:
type: string
example: urn:ietf:params:scim:api:messages:2.0:Error
status:
type: string
description: The HTTP status code of the error response.
detail:
type: string
description: A human-readable description of the error.
title: scim.v2.Error
example:
schemas:
- urn:ietf:params:scim:api:messages:2.0:Error
status: '429'
detail: Rate Limit Exceeded
'500':
description: Internal Server Error
x-minispec-transform-ignore: true
headers:
X-Request-Id:
schema:
type: string
description: The unique identifier for the API request.
content:
application/scim+json:
schema:
type: object
description: 'Standard SCIM error response format containing error details and status
information.
Returned when SCIM operations encounter validation errors or other issues.
'
properties:
schemas:
type: array
description: The SCIM schema for the error response.
items:
type: string
example: urn:ietf:params:scim:api:messages:2.0:Error
status:
type: string
description: The HTTP status code of the error response.
detail:
type: string
description: A human-readable description of the error.
title: scim.v2.Error
example:
schemas:
- urn:ietf:params:scim:api:messages:2.0:Error
status: '500'
detail: Internal Server Error
servers:
- url: https://api.confluent.cloud
description: Confluent Cloud API
jsonRequestBodyExample:
schemas:
- urn:ietf:params:scim:api:messages:2.0:PatchOp
Operations:
- op: replace
path: active
value: false