DescribeUserResponse schema from Amazon WorkMail API
Type: objectProperties: 8
Business CommunicationCalendarEmailExchangeEnterprise
DescribeUserResponse is a JSON Structure definition published by Amazon WorkMail, describing 8 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"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-structure.org/meta/core/v0/#",
"name": "DescribeUserResponse",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workmail/refs/heads/main/json-structure/workmail-describe-user-response-structure.json",
"description": "DescribeUserResponse schema from Amazon WorkMail API"
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.