Amplitude · JSON Structure

Scim Api Scim User List Response Structure

ScimUserListResponse schema from Amplitude SCIM API

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

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

Properties

schemas totalResults startIndex itemsPerPage Resources

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-list-response-structure.json",
  "name": "ScimUserListResponse",
  "description": "ScimUserListResponse schema from Amplitude SCIM API",
  "type": "object",
  "properties": {
    "schemas": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The SCIM schema URIs for this response."
    },
    "totalResults": {
      "type": "int32",
      "description": "The total number of matching users."
    },
    "startIndex": {
      "type": "int32",
      "description": "The 1-based index of the first result."
    },
    "itemsPerPage": {
      "type": "int32",
      "description": "The number of results returned in this page."
    },
    "Resources": {
      "type": "array",
      "description": "Array of SCIM user resources.",
      "items": {
        "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": "datetime",
                "description": "The date and time the resource was created."
              },
              "lastModified": {
                "type": "datetime",
                "description": "The date and time the resource was last modified."
              }
            }
          }
        }
      }
    }
  }
}