Amplitude · Schema

ScimUserRequest

A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior

Properties

Name	Type	Description
schemas	array	The SCIM schema URIs, typically urn:ietf:params:scim:schemas:core:2.0:User.
userName	string	The user's email address.
name	object
emails	array
active	boolean	Whether the user account should be active.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ScimUserRequest",
  "title": "ScimUserRequest",
  "type": "object",
  "required": [
    "schemas",
    "userName"
  ],
  "properties": {
    "schemas": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The SCIM schema URIs, typically urn:ietf:params:scim:schemas:core:2.0:User."
    },
    "userName": {
      "type": "string",
      "format": "email",
      "description": "The user's email address."
    },
    "name": {
      "type": "object",
      "properties": {
        "givenName": {
          "type": "string",
          "description": "The user's first name."
        },
        "familyName": {
          "type": "string",
          "description": "The user's last name."
        }
      }
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": {
            "type": "string",
            "format": "email",
            "description": "The email address."
          },
          "primary": {
            "type": "boolean",
            "description": "Whether this is the primary email."
          },
          "type": {
            "type": "string",
            "description": "The type of email."
          }
        }
      }
    },
    "active": {
      "type": "boolean",
      "description": "Whether the user account should be active."
    }
  }
}