Amplitude · JSON Structure

Scim Api Scim User Request Structure

ScimUserRequest schema from Amplitude SCIM API

Type: object Properties: 5 Required: 2
A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior

ScimUserRequest is a JSON Structure definition published by Amplitude, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

schemas userName name emails active

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amplitude/refs/heads/main/json-structure/scim-api-scim-user-request-structure.json",
  "name": "ScimUserRequest",
  "description": "ScimUserRequest schema from Amplitude SCIM API",
  "type": "object",
  "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."
    }
  },
  "required": [
    "schemas",
    "userName"
  ]
}