Skip to content

Amazon WorkMail API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<p>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.</p> <p>The WorkMail API is designed for the following scenarios:</p> <ul> <li> <p>Listing and describing organizations</p> </li> </ul> <ul> <li> <p>Managing users</p> </li> </ul> <ul> <li> <p>Managing groups</p> </li> </ul> <ul> <li> <p>Managing resources</p> </li> </ul> <p>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.</p>

Amazon WorkMail is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 80 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2017-10-01
Endpoints
80
Spec updated
2020-05-12

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=WorkMailService.AssociateDelegateToResourceAdds a member (user or group) to the resource's set of delegates.
POST/#X-Amz-Target=WorkMailService.AssociateMemberToGroupAdds a member (user or group) to the group's set.
POST/#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.
POST/#X-Amz-Target=WorkMailService.CancelMailboxExportJob<p>Cancels a mailbox export job.</p> <note> <p>If the mailbox export job is near completion, it might not be possible to cancel it.</p> </note>
POST/#X-Amz-Target=WorkMailService.CreateAliasAdds an alias to the set of a given member (user or group) of WorkMail.
POST/#X-Amz-Target=WorkMailService.CreateAvailabilityConfigurationCreates an <code>AvailabilityConfiguration</code> for the given WorkMail organization and domain.
POST/#X-Amz-Target=WorkMailService.CreateGroupCreates a group that can be used in WorkMail by calling the <a>RegisterToWorkMail</a> operation.
POST/#X-Amz-Target=WorkMailService.CreateImpersonationRole<p>Creates an impersonation role for the given WorkMail organization.</p> <p> <i>Idempotency</i> ensures that an API request completes no more than one time. Wi
POST/#X-Amz-Target=WorkMailService.CreateMobileDeviceAccessRuleCreates a new mobile device access rule for the specified WorkMail organization.
POST/#X-Amz-Target=WorkMailService.CreateOrganization<p>Creates a new WorkMail organization. Optionally, you can choose to associate an existing AWS Directory Service directory with your organization. If an AWS Di
POST/#X-Amz-Target=WorkMailService.CreateResourceCreates a new WorkMail resource.
POST/#X-Amz-Target=WorkMailService.CreateUserCreates a user who can be used in WorkMail by calling the <a>RegisterToWorkMail</a> operation.
POST/#X-Amz-Target=WorkMailService.DeleteAccessControlRule<p>Deletes an access control rule for the specified WorkMail organization.</p> <note> <p>Deleting already deleted and non-existing rules does not produce an err
POST/#X-Amz-Target=WorkMailService.DeleteAliasRemove one or more specified aliases from a set of aliases for a given user.
POST/#X-Amz-Target=WorkMailService.DeleteAvailabilityConfigurationDeletes the <code>AvailabilityConfiguration</code> for the given WorkMail organization and domain.
POST/#X-Amz-Target=WorkMailService.DeleteEmailMonitoringConfigurationDeletes the email monitoring configuration for a specified organization.
POST/#X-Amz-Target=WorkMailService.DeleteGroupDeletes a group from WorkMail.
POST/#X-Amz-Target=WorkMailService.DeleteImpersonationRoleDeletes an impersonation role for the given WorkMail organization.
POST/#X-Amz-Target=WorkMailService.DeleteMailboxPermissionsDeletes permissions granted to a member (user or group).
POST/#X-Amz-Target=WorkMailService.DeleteMobileDeviceAccessOverride<p>Deletes the mobile device access override for the given WorkMail organization, user, and device.</p> <note> <p>Deleting already deleted and non-existing over
POST/#X-Amz-Target=WorkMailService.DeleteMobileDeviceAccessRule<p>Deletes a mobile device access rule for the specified WorkMail organization.</p> <note> <p>Deleting already deleted and non-existing rules does not produce a
POST/#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 associat
POST/#X-Amz-Target=WorkMailService.DeleteResourceDeletes the specified resource.
POST/#X-Amz-Target=WorkMailService.DeleteRetentionPolicyDeletes the specified retention policy from the specified organization.
POST/#X-Amz-Target=WorkMailService.DeleteUser<p>Deletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be <code>DISABLED</code>. Use the <a>DescribeUser<
POST/#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 for
POST/#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 applica
POST/#X-Amz-Target=WorkMailService.DescribeEmailMonitoringConfigurationDescribes the current email monitoring configuration for a specified organization.
POST/#X-Amz-Target=WorkMailService.DescribeGroupReturns the data available for the group.
POST/#X-Amz-Target=WorkMailService.DescribeInboundDmarcSettingsLists the settings in a DMARC policy for a specified organization.
POST/#X-Amz-Target=WorkMailService.DescribeMailboxExportJobDescribes the current status of a mailbox export job.
POST/#X-Amz-Target=WorkMailService.DescribeOrganizationProvides more information regarding a given organization based on its identifier.
POST/#X-Amz-Target=WorkMailService.DescribeResourceReturns the data available for the resource.
POST/#X-Amz-Target=WorkMailService.DescribeUserProvides information regarding the user.
POST/#X-Amz-Target=WorkMailService.DisassociateDelegateFromResourceRemoves a member from the resource's set of delegates.
POST/#X-Amz-Target=WorkMailService.DisassociateMemberFromGroupRemoves a member from a group.
POST/#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 role
POST/#X-Amz-Target=WorkMailService.GetDefaultRetentionPolicyGets the default retention policy details for the specified organization.
POST/#X-Amz-Target=WorkMailService.GetImpersonationRoleGets the impersonation role details for the given WorkMail organization.
POST/#X-Amz-Target=WorkMailService.GetImpersonationRoleEffectTests whether the given impersonation role can impersonate a target user.
POST/#X-Amz-Target=WorkMailService.GetMailDomainGets details for a mail domain, including domain records required to configure your domain with recommended security.
POST/#X-Amz-Target=WorkMailService.GetMailboxDetailsRequests a user's mailbox details for a specified organization and user.
POST/#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 set
POST/#X-Amz-Target=WorkMailService.GetMobileDeviceAccessOverrideGets the mobile device access override for the given WorkMail organization, user, and device.
POST/#X-Amz-Target=WorkMailService.ListAccessControlRulesLists the access control rules for the specified organization.
POST/#X-Amz-Target=WorkMailService.ListAliasesCreates a paginated call to list the aliases associated with a given entity.
POST/#X-Amz-Target=WorkMailService.ListAvailabilityConfigurationsList all the <code>AvailabilityConfiguration</code>'s for the given WorkMail organization.
POST/#X-Amz-Target=WorkMailService.ListGroupMembersReturns an overview of the members of a group. Users and groups can be members of a group.
POST/#X-Amz-Target=WorkMailService.ListGroupsReturns summaries of the organization's groups.
POST/#X-Amz-Target=WorkMailService.ListImpersonationRolesLists all the impersonation roles for the given WorkMail organization.
POST/#X-Amz-Target=WorkMailService.ListMailDomainsLists the mail domains in a given WorkMail organization.
POST/#X-Amz-Target=WorkMailService.ListMailboxExportJobsLists the mailbox export jobs started for the specified organization within the last seven days.
POST/#X-Amz-Target=WorkMailService.ListMailboxPermissionsLists the mailbox permissions associated with a user, group, or resource mailbox.
POST/#X-Amz-Target=WorkMailService.ListMobileDeviceAccessOverridesLists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.
POST/#X-Amz-Target=WorkMailService.ListMobileDeviceAccessRulesLists the mobile device access rules for the specified WorkMail organization.
POST/#X-Amz-Target=WorkMailService.ListOrganizationsReturns summaries of the customer's organizations.
POST/#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.
POST/#X-Amz-Target=WorkMailService.ListResourcesReturns summaries of the organization's resources.
POST/#X-Amz-Target=WorkMailService.ListTagsForResourceLists the tags applied to an WorkMail organization resource.
POST/#X-Amz-Target=WorkMailService.ListUsersReturns summaries of the organization's users.
POST/#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 pro
POST/#X-Amz-Target=WorkMailService.PutEmailMonitoringConfigurationCreates or updates the email monitoring configuration for a specified organization.
POST/#X-Amz-Target=WorkMailService.PutInboundDmarcSettingsEnables or disables a DMARC policy for a given organization.
POST/#X-Amz-Target=WorkMailService.PutMailboxPermissionsSets permissions for a user, group, or resource. This replaces any pre-existing permissions.
POST/#X-Amz-Target=WorkMailService.PutMobileDeviceAccessOverrideCreates or updates a mobile device access override for the given WorkMail organization, user, and device.
POST/#X-Amz-Target=WorkMailService.PutRetentionPolicyPuts a retention policy to the specified organization.
POST/#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 o
POST/#X-Amz-Target=WorkMailService.RegisterToWorkMail<p>Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if
POST/#X-Amz-Target=WorkMailService.ResetPasswordAllows the administrator to reset the password for a user.
POST/#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 (A
POST/#X-Amz-Target=WorkMailService.TagResourceApplies the specified tags to the specified WorkMailorganization resource.
POST/#X-Amz-Target=WorkMailService.TestAvailabilityConfiguration<p>Performs 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 i
POST/#X-Amz-Target=WorkMailService.UntagResourceUntags the specified tags from the specified WorkMail organization resource.
POST/#X-Amz-Target=WorkMailService.UpdateAvailabilityConfigurationUpdates an existing <code>AvailabilityConfiguration</code> for the given WorkMail organization and domain.
POST/#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 mai
POST/#X-Amz-Target=WorkMailService.UpdateImpersonationRoleUpdates an impersonation role for the given WorkMail organization.
POST/#X-Amz-Target=WorkMailService.UpdateMailboxQuotaUpdates a user's current mailbox quota for a specified organization and user.
POST/#X-Amz-Target=WorkMailService.UpdateMobileDeviceAccessRuleUpdates a mobile device access rule for the specified WorkMail organization.
POST/#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 curr
POST/#X-Amz-Target=WorkMailService.UpdateResourceUpdates data for the resource. To have the latest information, it must be preceded by a <a>DescribeResource</a> call. The dataset in the request should be the o

Questions

Does the Amazon WorkMail API need an API key?

Yes. The Amazon WorkMail API uses API key authentication; the documentation explains how to get credentials.

Does the Amazon WorkMail API support HTTPS?

Yes, the Amazon WorkMail API is served over HTTPS.

How many endpoints does the Amazon WorkMail API have?

Its OpenAPI description lists 80 endpoints in version 2017-10-01. All of them are shown on this page.

What are alternatives to the Amazon WorkMail API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).