1. Docs
  2. API Reference
  3. ScimUserDto

ScimUserDto

Example

JSON
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "string",
  "externalId": "string",
  "userName": "string",
  "name": {
    "givenName": "string",
    "familyName": "string"
  },
  "emails": [
    {
      "value": "string",
      "primary": false,
      "type": "work"
    }
  ],
  "active": false,
  "meta": {
    "resourceType": "User",
    "created": "2026-04-20T12:00:00.000Z",
    "lastModified": "2026-04-20T12:00:00.000Z",
    "location": "string",
    "version": "string"
  }
}

Properties

8 properties 7 required

schemas array of string Required
Exampleurn:ietf:params:scim:schemas:core:2.0:User
id string Required

This directory's id for the person

externalId string Optional
userName string Required

The sign-in email, lowercased

name ScimNameDto Required
emails array of ScimEmailDto Required
active boolean Required

Whether the person is active in this directory

meta ScimMetaDto Required
Was this page helpful?

Tell us how we can improve this guide.