contentstack · Schema

ScimUser

A SCIM 2.0 User resource representing a Contentstack user account.

Properties

Name Type Description
schemas array SCIM schema URNs for this resource.
id string SCIM-assigned unique identifier for the user.
userName string The user's email address used as the primary unique identifier.
name object The user's name components.
emails array List of email addresses for the user.
active boolean Indicates whether the user account is active. Set to false to deprovision (deactivate) the user in Contentstack.
View JSON Schema on GitHub

JSON Schema

contentstack-scimuser-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ScimUser",
  "title": "ScimUser",
  "type": "object",
  "description": "A SCIM 2.0 User resource representing a Contentstack user account.",
  "properties": {
    "schemas": {
      "type": "array",
      "description": "SCIM schema URNs for this resource.",
      "items": {
        "type": "string"
      },
      "example": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ]
    },
    "id": {
      "type": "string",
      "description": "SCIM-assigned unique identifier for the user."
    },
    "userName": {
      "type": "string",
      "format": "email",
      "description": "The user's email address used as the primary unique 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": "List of email addresses for the user.",
      "items": {
        "type": "object",
        "properties": {
          "value": {
            "type": "string",
            "format": "email",
            "description": "The email address value."
          },
          "primary": {
            "type": "boolean",
            "description": "Indicates whether this is the primary email address."
          }
        }
      }
    },
    "active": {
      "type": "boolean",
      "description": "Indicates whether the user account is active. Set to false to deprovision (deactivate) the user in Contentstack."
    }
  }
}