Amazon WorkMail · Schema

DescribeUserResponse

DescribeUserResponse schema from Amazon WorkMail API

Business CommunicationCalendarEmailExchangeEnterprise

Properties

Name Type Description
UserId object
Name object
Email object
DisplayName object
State object
UserRole object
EnabledDate object
DisabledDate object
View JSON Schema on GitHub

JSON Schema

workmail-describe-user-response-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "UserId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkMailIdentifier"
        },
        {
          "description": "The identifier for the described user."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserName"
        },
        {
          "description": "The name for the user."
        }
      ]
    },
    "Email": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EmailAddress"
        },
        {
          "description": "The email of the user."
        }
      ]
    },
    "DisplayName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The display name of the user."
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityState"
        },
        {
          "description": "The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail)."
        }
      ]
    },
    "UserRole": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserRole"
        },
        {
          "description": "In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, and SYSTEM_USER."
        }
      ]
    },
    "EnabledDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format."
        }
      ]
    },
    "DisabledDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format."
        }
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "DescribeUserResponse",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-schema/workmail-describe-user-response-schema.json",
  "description": "DescribeUserResponse schema from Amazon WorkMail API"
}