Search for Users
GET/scim/v2/sso/:connection_name/Users
Make a request to find a user.
Search for users in the organization using SCIM filter expressions. This endpoint supports filtering by user attributes such as userName to locate existing users or verify if a user account already exists before provisioning.
Request
Responses
- 200
- 400
- 401
- 403
- 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.
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:
get:
x-lifecycle-stage: General Availability
x-self-access: true
x-name: scim.v2.Users
operationId: findScimV2User
description: '[](#section/Versioning/API-Lifecycle-Policy)
Make a request to find a user.
Search for users in the organization using SCIM filter expressions. This endpoint supports
filtering by user attributes such as userName to locate existing users or verify if a user
account already exists before provisioning.
'
parameters:
- name: filter
in: query
required: true
schema:
description: Filter a collection by a string search
type: string
title: SearchFilter
example: userName eq "marty.mcfly@example.com"
description: 'SCIM filter expression for searching users. Supports filtering by user attributes
using SCIM filter syntax (e.g., `userName eq "user@example.com"` to find a user by email).
'
- name: connection_name
in: path
required: true
schema:
type: string
description: The Connection Name
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:
allOf:
- type: object
description: 'A SCIM ListResponse containing a list of User resources and pagination
information.
'
properties:
schemas:
type: array
description: The SCIM schema.
items:
type: string
example: urn:ietf:params:scim:api:messages:2.0:ListResponse
totalResults:
type: integer
format: int32
description: The total number of results returned by the list or query operation.
example: 2
startIndex:
type: integer
format: int32
description: The 1-based index of the first result in the current set of list results.
example: 1
itemsPerPage:
type: integer
format: int32
description: The number of resources returned in a list response page.
example: 1
Resources:
type: array
description: A multi-valued list of complex objects containing the requested resources.
items:
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
'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