---
title: "Retrieve a scim user. This type of user holds personally identifiable information"
method: POST
path: "/scim/users/search"
tags: ["scim"]
---

# Retrieve a scim user. This type of user holds personally identifiable information

`POST /scim/users/search`

## Request

- Base URL: `https://identity.moneyhub.co.uk`
- URL: `https://identity.moneyhub.co.uk/scim/users/search`
- Auth: API key in header `Authorization`

Requires **scim_user:read** scope.

## Request body

- ScimUserSearch
  - `externalId` string, required: A String that is an identifier for the resource as defined by the provisioning client.
  - `email` string, email, required: The email address

## Response `200`

Successful User Response

- ScimUser
  - `schemas` string[], required
  - `id` string, required: The unique identifier for a User.
  - `externalId` string, required: A String that is an identifier for the resource as defined by the provisioning client.
  - `meta` object, required
    - `resourceType` 'User', required: The name of the resource type of the resource.
    - `created` string, date-time, required: The date and time the resource was created.
  - `name` object, required
    - `familyName` string, required: The given name or first name of the User
    - `givenName` string, required: The family name or last name of the User
  - `emails` object[], required
    - `value` string, email, required: The email address
    - `primary` boolean, required: Indicates the primary email address. The primary attribute value 'true' MUST appear no more than once.
  - `userType` 'live' | 'guest': The user type

## Other responses

- `400`: Unsuccessful Response - Bad request - Missing query parameters - Missing body properties
- `401`: Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
- `403`: Unsuccessful Response - Forbidden - Invalid scopes
- `404`: Unsuccessful Response - Not Found - User not found

## Changes

- **2026-11-03** `e004d9ee1fdb`: 8 warning
  - removed the optional property `id` from the response with the `400` status
  - removed the optional property `id` from the response with the `401` status
  - removed the optional property `id` from the response with the `403` status
  - removed the optional property `id` from the response with the `404` status
  - …4 more

[Operation history](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-identity-service/changes/scim/users/search/post.md)

---

[API](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-identity-service.md) - [All operations](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-identity-service/llms.txt) - [OpenAPI document](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-identity-service/revisions/e004d9ee1fdb?raw)