Amazon WorkMail
WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email,…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
WorkMail is a secure, managed business email and calendaring service with support for
existing desktop and mobile email clients. You can access your email, contacts, and
calendars using Microsoft Outlook, your browser, or other native iOS and Android email
applications. You can integrate WorkMail with your existing corporate directory and control
both the keys that encrypt your data and the location in which your data is
stored.
The WorkMail API is designed for the following scenarios:
Listing and describing organizations
Managing users
Managing groups
Managing resources
All WorkMail API operations are Amazon-authenticated and certificate-signed. They not
only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management
users and roles to help facilitate access, trust, and permission policies. By creating a
role and allowing an IAM user to access the WorkMail site, the IAM user gains full
administrative visibility into the entire WorkMail organization (or as set in the IAM
policy). This includes, but is not limited to, the ability to create, update, and delete
users, groups, and resources. This allows developers to perform the scenarios listed above,
as well as give users the ability to grant access on a selective basis using the IAM
model.
Endpoints 92
- POSTAssociate delegate to resource
/#X-Amz-Target=WorkMailService.AssociateDelegateToResourceAdds a member (user or group) to the resource's set of delegates. - POSTAssociate member to group
/#X-Amz-Target=WorkMailService.AssociateMemberToGroupAdds a member (user or group) to the group's set. - POSTAssume impersonation role
/#X-Amz-Target=WorkMailService.AssumeImpersonationRoleAssumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls. - POSTCancel mailbox export job
/#X-Amz-Target=WorkMailService.CancelMailboxExportJobCancels a mailbox export job. If the mailbox export job is near completion, it might not be possible to cancel it. - POSTCreate alias
/#X-Amz-Target=WorkMailService.CreateAliasAdds an alias to the set of a given member (user or group) of WorkMail. - POSTCreate availability configuration
/#X-Amz-Target=WorkMailService.CreateAvailabilityConfigurationCreates an AvailabilityConfiguration for the given WorkMail organization and domain. - POSTCreate group
/#X-Amz-Target=WorkMailService.CreateGroupCreates a group that can be used in WorkMail by calling the RegisterToWorkMail operation. - POSTCreate identity center application
/#X-Amz-Target=WorkMailService.CreateIdentityCenterApplicationCreates the WorkMail application in IAM Identity Center that can be used later in the WorkMail - IdC integration. For more information, see… - POSTCreate impersonation role
/#X-Amz-Target=WorkMailService.CreateImpersonationRoleCreates an impersonation role for the given WorkMail organization. Idempotency ensures that an API request completes no more than one time. With an idempotent… - POSTCreate mobile device access rule
/#X-Amz-Target=WorkMailService.CreateMobileDeviceAccessRuleCreates a new mobile device access rule for the specified WorkMail organization. - POSTCreate organization
/#X-Amz-Target=WorkMailService.CreateOrganizationCreates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS… - POSTCreate resource
/#X-Amz-Target=WorkMailService.CreateResourceCreates a new WorkMail resource. - POSTCreate user
/#X-Amz-Target=WorkMailService.CreateUserCreates a user who can be used in WorkMail by calling the RegisterToWorkMail operation. - POSTDelete access control rule
/#X-Amz-Target=WorkMailService.DeleteAccessControlRuleDeletes an access control rule for the specified WorkMail organization. Deleting already deleted and non-existing rules does not produce an error. In those… - POSTDelete alias
/#X-Amz-Target=WorkMailService.DeleteAliasRemove one or more specified aliases from a set of aliases for a given user. - POSTDelete availability configuration
/#X-Amz-Target=WorkMailService.DeleteAvailabilityConfigurationDeletes the AvailabilityConfiguration for the given WorkMail organization and domain. - POSTDelete email monitoring configuration
/#X-Amz-Target=WorkMailService.DeleteEmailMonitoringConfigurationDeletes the email monitoring configuration for a specified organization. - POSTDelete group
/#X-Amz-Target=WorkMailService.DeleteGroupDeletes a group from WorkMail. - POSTDelete identity center application
/#X-Amz-Target=WorkMailService.DeleteIdentityCenterApplicationDeletes the IAM Identity Center application from WorkMail. This action does not affect the authentication settings for any WorkMail organizations. - POSTDelete identity provider configuration
/#X-Amz-Target=WorkMailService.DeleteIdentityProviderConfigurationDisables the integration between IdC and WorkMail. Authentication will continue with the directory as it was before the IdC integration. You might have to… - POSTDelete impersonation role
/#X-Amz-Target=WorkMailService.DeleteImpersonationRoleDeletes an impersonation role for the given WorkMail organization. - POSTDelete mailbox permissions
/#X-Amz-Target=WorkMailService.DeleteMailboxPermissionsDeletes permissions granted to a member (user or group). - POSTDelete mobile device access override
/#X-Amz-Target=WorkMailService.DeleteMobileDeviceAccessOverrideDeletes the mobile device access override for the given WorkMail organization, user, and device. Deleting already deleted and non-existing overrides does not… - POSTDelete mobile device access rule
/#X-Amz-Target=WorkMailService.DeleteMobileDeviceAccessRuleDeletes a mobile device access rule for the specified WorkMail organization. Deleting already deleted and non-existing rules does not produce an error. In… - POSTDelete organization
/#X-Amz-Target=WorkMailService.DeleteOrganizationDeletes an WorkMail organization and all underlying AWS resources managed by WorkMail as part of the organization. You can choose whether to delete the… - POSTDelete personal access token
/#X-Amz-Target=WorkMailService.DeletePersonalAccessTokenDeletes the Personal Access Token from the provided WorkMail Organization. - POSTDelete resource
/#X-Amz-Target=WorkMailService.DeleteResourceDeletes the specified resource. - POSTDelete retention policy
/#X-Amz-Target=WorkMailService.DeleteRetentionPolicyDeletes the specified retention policy from the specified organization. - POSTDelete user
/#X-Amz-Target=WorkMailService.DeleteUserDeletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED . Use the DescribeUser action to… - POSTDeregister from work mail
/#X-Amz-Target=WorkMailService.DeregisterFromWorkMailMark a user, group, or resource as no longer used in WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes… - POSTDeregister mail domain
/#X-Amz-Target=WorkMailService.DeregisterMailDomainRemoves a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other… - POSTDescribe email monitoring configuration
/#X-Amz-Target=WorkMailService.DescribeEmailMonitoringConfigurationDescribes the current email monitoring configuration for a specified organization. - POSTDescribe entity
/#X-Amz-Target=WorkMailService.DescribeEntityReturns basic details about an entity in WorkMail. - POSTDescribe group
/#X-Amz-Target=WorkMailService.DescribeGroupReturns the data available for the group. - POSTDescribe identity provider configuration
/#X-Amz-Target=WorkMailService.DescribeIdentityProviderConfigurationReturns detailed information on the current IdC setup for the WorkMail organization. - POSTDescribe inbound dmarc settings
/#X-Amz-Target=WorkMailService.DescribeInboundDmarcSettingsLists the settings in a DMARC policy for a specified organization. - POSTDescribe mailbox export job
/#X-Amz-Target=WorkMailService.DescribeMailboxExportJobDescribes the current status of a mailbox export job. - POSTDescribe organization
/#X-Amz-Target=WorkMailService.DescribeOrganizationProvides more information regarding a given organization based on its identifier. - POSTDescribe resource
/#X-Amz-Target=WorkMailService.DescribeResourceReturns the data available for the resource. - POSTDescribe user
/#X-Amz-Target=WorkMailService.DescribeUserProvides information regarding the user. - POSTDisassociate delegate from resource
/#X-Amz-Target=WorkMailService.DisassociateDelegateFromResourceRemoves a member from the resource's set of delegates. - POSTDisassociate member from group
/#X-Amz-Target=WorkMailService.DisassociateMemberFromGroupRemoves a member from a group. - POSTGet access control effect
/#X-Amz-Target=WorkMailService.GetAccessControlEffectGets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, and user ID or impersonation… - POSTGet default retention policy
/#X-Amz-Target=WorkMailService.GetDefaultRetentionPolicyGets the default retention policy details for the specified organization. - POSTGet impersonation role
/#X-Amz-Target=WorkMailService.GetImpersonationRoleGets the impersonation role details for the given WorkMail organization. - POSTGet impersonation role effect
/#X-Amz-Target=WorkMailService.GetImpersonationRoleEffectTests whether the given impersonation role can impersonate a target user. - POSTGet mail domain
/#X-Amz-Target=WorkMailService.GetMailDomainGets details for a mail domain, including domain records required to configure your domain with recommended security. - POSTGet mailbox details
/#X-Amz-Target=WorkMailService.GetMailboxDetailsRequests a user's mailbox details for a specified organization and user. - POSTGet mobile device access effect
/#X-Amz-Target=WorkMailService.GetMobileDeviceAccessEffectSimulates the effect of the mobile device access rules for the given attributes of a sample access event. Use this method to test the effects of the current… - POSTGet mobile device access override
/#X-Amz-Target=WorkMailService.GetMobileDeviceAccessOverrideGets the mobile device access override for the given WorkMail organization, user, and device. - POSTGet personal access token metadata
/#X-Amz-Target=WorkMailService.GetPersonalAccessTokenMetadataRequests details of a specific Personal Access Token within the WorkMail organization. - POSTList access control rules
/#X-Amz-Target=WorkMailService.ListAccessControlRulesLists the access control rules for the specified organization. - POSTList aliases
/#X-Amz-Target=WorkMailService.ListAliasesCreates a paginated call to list the aliases associated with a given entity. - POSTList availability configurations
/#X-Amz-Target=WorkMailService.ListAvailabilityConfigurationsList all the AvailabilityConfiguration 's for the given WorkMail organization. - POSTList group members
/#X-Amz-Target=WorkMailService.ListGroupMembersReturns an overview of the members of a group. Users and groups can be members of a group. - POSTList groups
/#X-Amz-Target=WorkMailService.ListGroupsReturns summaries of the organization's groups. - POSTList groups for entity
/#X-Amz-Target=WorkMailService.ListGroupsForEntityReturns all the groups to which an entity belongs. - POSTList impersonation roles
/#X-Amz-Target=WorkMailService.ListImpersonationRolesLists all the impersonation roles for the given WorkMail organization. - POSTList mail domains
/#X-Amz-Target=WorkMailService.ListMailDomainsLists the mail domains in a given WorkMail organization. - POSTList mailbox export jobs
/#X-Amz-Target=WorkMailService.ListMailboxExportJobsLists the mailbox export jobs started for the specified organization within the last seven days. - POSTList mailbox permissions
/#X-Amz-Target=WorkMailService.ListMailboxPermissionsLists the mailbox permissions associated with a user, group, or resource mailbox. - POSTList mobile device access overrides
/#X-Amz-Target=WorkMailService.ListMobileDeviceAccessOverridesLists all the mobile device access overrides for any given combination of WorkMail organization, user, or device. - POSTList mobile device access rules
/#X-Amz-Target=WorkMailService.ListMobileDeviceAccessRulesLists the mobile device access rules for the specified WorkMail organization. - POSTList organizations
/#X-Amz-Target=WorkMailService.ListOrganizationsReturns summaries of the customer's organizations. - POSTList personal access tokens
/#X-Amz-Target=WorkMailService.ListPersonalAccessTokensReturns a summary of your Personal Access Tokens. - POSTList resource delegates
/#X-Amz-Target=WorkMailService.ListResourceDelegatesLists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource. - POSTList resources
/#X-Amz-Target=WorkMailService.ListResourcesReturns summaries of the organization's resources. - POSTList tags for resource
/#X-Amz-Target=WorkMailService.ListTagsForResourceLists the tags applied to an WorkMail organization resource. - POSTList users
/#X-Amz-Target=WorkMailService.ListUsersReturns summaries of the organization's users. - POSTPut access control rule
/#X-Amz-Target=WorkMailService.PutAccessControlRuleAdds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access… - POSTPut email monitoring configuration
/#X-Amz-Target=WorkMailService.PutEmailMonitoringConfigurationCreates or updates the email monitoring configuration for a specified organization. - POSTPut identity provider configuration
/#X-Amz-Target=WorkMailService.PutIdentityProviderConfigurationEnables integration between IAM Identity Center (IdC) and WorkMail to proxy authentication requests for mailbox users. You can connect your IdC directory or… - POSTPut inbound dmarc settings
/#X-Amz-Target=WorkMailService.PutInboundDmarcSettingsEnables or disables a DMARC policy for a given organization. - POSTPut mailbox permissions
/#X-Amz-Target=WorkMailService.PutMailboxPermissionsSets permissions for a user, group, or resource. This replaces any pre-existing permissions. - POSTPut mobile device access override
/#X-Amz-Target=WorkMailService.PutMobileDeviceAccessOverrideCreates or updates a mobile device access override for the given WorkMail organization, user, and device. - POSTPut retention policy
/#X-Amz-Target=WorkMailService.PutRetentionPolicyPuts a retention policy to the specified organization. - POSTRegister mail domain
/#X-Amz-Target=WorkMailService.RegisterMailDomainRegisters a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail… - POSTRegister to work mail
/#X-Amz-Target=WorkMailService.RegisterToWorkMailRegisters an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if… - POSTReset password
/#X-Amz-Target=WorkMailService.ResetPasswordAllows the administrator to reset the password for a user. - POSTStart mailbox export job
/#X-Amz-Target=WorkMailService.StartMailboxExportJobStarts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service… - POSTTag resource
/#X-Amz-Target=WorkMailService.TagResourceApplies the specified tags to the specified WorkMailorganization resource. - POSTTest availability configuration
/#X-Amz-Target=WorkMailService.TestAvailabilityConfigurationPerforms a test on an availability provider to ensure that access is allowed. For EWS, it verifies the provided credentials can be used to successfully log… - POSTUntag resource
/#X-Amz-Target=WorkMailService.UntagResourceUntags the specified tags from the specified WorkMail organization resource. - POSTUpdate availability configuration
/#X-Amz-Target=WorkMailService.UpdateAvailabilityConfigurationUpdates an existing AvailabilityConfiguration for the given WorkMail organization and domain. - POSTUpdate default mail domain
/#X-Amz-Target=WorkMailService.UpdateDefaultMailDomainUpdates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a… - POSTUpdate group
/#X-Amz-Target=WorkMailService.UpdateGroupUpdates attributes in a group. - POSTUpdate impersonation role
/#X-Amz-Target=WorkMailService.UpdateImpersonationRoleUpdates an impersonation role for the given WorkMail organization. - POSTUpdate mailbox quota
/#X-Amz-Target=WorkMailService.UpdateMailboxQuotaUpdates a user's current mailbox quota for a specified organization and user. - POSTUpdate mobile device access rule
/#X-Amz-Target=WorkMailService.UpdateMobileDeviceAccessRuleUpdates a mobile device access rule for the specified WorkMail organization. - POSTUpdate primary email address
/#X-Amz-Target=WorkMailService.UpdatePrimaryEmailAddressUpdates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the… - POSTUpdate resource
/#X-Amz-Target=WorkMailService.UpdateResourceUpdates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one… - POSTUpdate user
/#X-Amz-Target=WorkMailService.UpdateUserUpdates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The dataset in the request should be the one expected…
API details
- Base URL
https://workmail.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 92 operations on 92 pathsPOST 92
- Description format
- AWS Smithy model, API version
2017-10-01 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon WorkMail in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon WorkMail collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Associate delegate to resource” (POST /#X-Amz-Target=WorkMailService.AssociateDelegateToResource), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon WorkMail?
WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email,… It is listed under Communication and has 92 endpoints.
Who publishes the Amazon WorkMail?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon WorkMail?
Requests go to https://workmail.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon WorkMail?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon WorkMail have?
92 operations on 92 paths (92 POST).
Is forking the Amazon WorkMail free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.