SCIMUserRequest

Fields

Inbound SCIM user payload; the protocol schemas member is required.

10 fields

active

boolean

displayName

string or null

emails

array of SCIMEmail

externalId

string or null

groups

array of SCIMGroup

id

string or null

meta

object or null

name

SCIMName or null

schemas · required

array of string

userName · required

string

Raw schema (JSON)

{
  "description": "Inbound SCIM user payload; the protocol schemas member is required.",
  "properties": {
    "active": {
      "default": true,
      "title": "Active",
      "type": "boolean"
    },
    "displayName": {
      "anyOf": [
        {
          "maxLength": 255,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Displayname"
    },
    "emails": {
      "default": [],
      "items": {
        "$ref": "#/components/schemas/SCIMEmail"
      },
      "maxItems": 100,
      "title": "Emails",
      "type": "array"
    },
    "externalId": {
      "anyOf": [
        {
          "maxLength": 1000,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Externalid"
    },
    "groups": {
      "default": [],
      "items": {
        "$ref": "#/components/schemas/SCIMGroup"
      },
      "maxItems": 1000,
      "title": "Groups",
      "type": "array"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Id"
    },
    "meta": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Meta"
    },
    "name": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/SCIMName"
        },
        {
          "type": "null"
        }
      ]
    },
    "schemas": {
      "items": {
        "type": "string"
      },
      "title": "Schemas",
      "type": "array"
    },
    "userName": {
      "maxLength": 100,
      "minLength": 1,
      "title": "Username",
      "type": "string"
    }
  },
  "required": [
    "schemas",
    "userName"
  ],
  "title": "SCIMUserRequest",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

• POST /api/v1/scim/v2/Users — Scim Create
• PUT /api/v1/scim/v2/Users/{user_id} — Scim Replace

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON