Amplitude · Schema

ScimUserListResponse

ScimUserListResponse schema from Amplitude SCIM API

A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior

Properties

Name Type Description
schemas array The SCIM schema URIs for this response.
totalResults integer The total number of matching users.
startIndex integer The 1-based index of the first result.
itemsPerPage integer The number of results returned in this page.
Resources array Array of SCIM user resources.
View JSON Schema on GitHub

JSON Schema

scim-api-scim-user-list-response-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-list-response-schema.json",
  "title": "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": "integer",
      "description": "The total number of matching users."
    },
    "startIndex": {
      "type": "integer",
      "description": "The 1-based index of the first result."
    },
    "itemsPerPage": {
      "type": "integer",
      "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": "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."
              }
            }
          }
        }
      }
    }
  }
}