Amplitude · Schema

ScimUser

ScimUser schema from Amplitude SCIM API

A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior

Properties

Name Type Description
schemas array The SCIM schema URIs for this resource.
id string The SCIM unique identifier for the user.
userName string The user's email address, used as the primary identifier.
name object The user's name components.
emails array Array of email addresses for the user.
active boolean Whether the user account is active.
groups array Array of groups the user belongs to.
meta object SCIM metadata for the resource.
View JSON Schema on GitHub

JSON Schema

scim-api-scim-user-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amplitude/refs/heads/main/json-schema/scim-api-scim-user-schema.json",
  "title": "ScimUser",
  "description": "ScimUser schema from Amplitude SCIM API",
  "type": "object",
  "properties": {
    "schemas": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The SCIM schema URIs for this resource."
    },
    "id": {
      "type": "string",
      "description": "The SCIM unique identifier for the user."
    },
    "userName": {
      "type": "string",
      "format": "email",
      "description": "The user's email address, used as the primary identifier."
    },
    "name": {
      "type": "object",
      "description": "The user's name components.",
      "properties": {
        "givenName": {
          "type": "string",
          "description": "The user's first name."
        },
        "familyName": {
          "type": "string",
          "description": "The user's last name."
        }
      }
    },
    "emails": {
      "type": "array",
      "description": "Array of email addresses for the user.",
      "items": {
        "type": "object",
        "properties": {
          "value": {
            "type": "string",
            "format": "email",
            "description": "The email address."
          },
          "primary": {
            "type": "boolean",
            "description": "Whether this is the primary email address."
          },
          "type": {
            "type": "string",
            "description": "The type of email address such as work or personal."
          }
        }
      }
    },
    "active": {
      "type": "boolean",
      "description": "Whether the user account is active."
    },
    "groups": {
      "type": "array",
      "description": "Array of groups the user belongs to.",
      "items": {
        "type": "object",
        "properties": {
          "value": {
            "type": "string",
            "description": "The group ID."
          },
          "display": {
            "type": "string",
            "description": "The group display name."
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "description": "SCIM metadata for the resource.",
      "properties": {
        "resourceType": {
          "type": "string",
          "description": "The type of SCIM resource."
        },
        "created": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time the resource was created."
        },
        "lastModified": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time the resource was last modified."
        }
      }
    }
  }
}