Skip to content

AWS Directory Service API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<fullname>Directory Service</fullname> <p>Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active Directory. This guide provides detailed information about Directory Service operations, data types, parameters, and errors. For information about Directory Services features, see <a href="https://aws.amazon.com/directoryservice/">Directory Service</a> and the <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html">Directory Service Administration Guide</a>.</p> <note> <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p> </note>

AWS Directory Service is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 67 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2015-04-16
Endpoints
67
Spec updated
2020-03-11

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=DirectoryService_20150416.AcceptSharedDirectoryAccepts a directory sharing request that was sent from the directory owner account.
POST/#X-Amz-Target=DirectoryService_20150416.AddIpRoutes<p>If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and fr
POST/#X-Amz-Target=DirectoryService_20150416.AddRegionAdds two domain controllers in the specified Region for the specified directory.
POST/#X-Amz-Target=DirectoryService_20150416.AddTagsToResourceAdds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Ta
POST/#X-Amz-Target=DirectoryService_20150416.CancelSchemaExtensionCancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no
POST/#X-Amz-Target=DirectoryService_20150416.ConnectDirectory<p>Creates an AD Connector to connect to a self-managed directory.</p> <p>Before you call <code>ConnectDirectory</code>, ensure that all of the required permiss
POST/#X-Amz-Target=DirectoryService_20150416.CreateAlias<p>Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as <code>http:
POST/#X-Amz-Target=DirectoryService_20150416.CreateComputerCreates an Active Directory computer object in the specified directory.
POST/#X-Amz-Target=DirectoryService_20150416.CreateConditionalForwarderCreates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust relationship
POST/#X-Amz-Target=DirectoryService_20150416.CreateDirectory<p>Creates a Simple AD directory. For more information, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html">S
POST/#X-Amz-Target=DirectoryService_20150416.CreateLogSubscriptionCreates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Se
POST/#X-Amz-Target=DirectoryService_20150416.CreateMicrosoftAD<p>Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see <a href="https://docs.aws.amazon.com/directoryservice/latest/adm
POST/#X-Amz-Target=DirectoryService_20150416.CreateSnapshot<p>Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.</p> <note> <p>You cannot take snapshots of AD Connector directo
POST/#X-Amz-Target=DirectoryService_20150416.CreateTrust<p>Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Mic
POST/#X-Amz-Target=DirectoryService_20150416.DeleteConditionalForwarderDeletes a conditional forwarder that has been set up for your Amazon Web Services directory.
POST/#X-Amz-Target=DirectoryService_20150416.DeleteDirectory<p>Deletes an Directory Service directory.</p> <p>Before you call <code>DeleteDirectory</code>, ensure that all of the required permissions have been explicitly
POST/#X-Amz-Target=DirectoryService_20150416.DeleteLogSubscriptionDeletes the specified log subscription.
POST/#X-Amz-Target=DirectoryService_20150416.DeleteSnapshotDeletes a directory snapshot.
POST/#X-Amz-Target=DirectoryService_20150416.DeleteTrustDeletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
POST/#X-Amz-Target=DirectoryService_20150416.DeregisterCertificateDeletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
POST/#X-Amz-Target=DirectoryService_20150416.DeregisterEventTopicRemoves the specified directory as a publisher to the specified Amazon SNS topic.
POST/#X-Amz-Target=DirectoryService_20150416.DescribeCertificateDisplays information about the certificate registered for secure LDAP or client certificate authentication.
POST/#X-Amz-Target=DirectoryService_20150416.DescribeClientAuthenticationSettingsRetrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about
POST/#X-Amz-Target=DirectoryService_20150416.DescribeConditionalForwarders<p>Obtains information about the conditional forwarders for this account.</p> <p>If no input parameters are provided for RemoteDomainNames, this request describ
POST/#X-Amz-Target=DirectoryService_20150416.DescribeDirectories<p>Obtains information about the directories that belong to this account.</p> <p>You can retrieve information about specific directories by passing the director
POST/#X-Amz-Target=DirectoryService_20150416.DescribeDomainControllersProvides information about any domain controllers in your directory.
POST/#X-Amz-Target=DirectoryService_20150416.DescribeEventTopics<p>Obtains information about which Amazon SNS topics receive status messages from the specified directory.</p> <p>If no input parameters are provided, such as D
POST/#X-Amz-Target=DirectoryService_20150416.DescribeLDAPSSettingsDescribes the status of LDAP security for the specified directory.
POST/#X-Amz-Target=DirectoryService_20150416.DescribeRegionsProvides information about the Regions that are configured for multi-Region replication.
POST/#X-Amz-Target=DirectoryService_20150416.DescribeSettingsRetrieves information about the configurable settings for the specified directory.
POST/#X-Amz-Target=DirectoryService_20150416.DescribeSharedDirectoriesReturns the shared directories in your account.
POST/#X-Amz-Target=DirectoryService_20150416.DescribeSnapshots<p>Obtains information about the directory snapshots that belong to this account.</p> <p>This operation supports pagination with the use of the <i>NextToken</i>
POST/#X-Amz-Target=DirectoryService_20150416.DescribeTrusts<p>Obtains information about the trust relationships for this account.</p> <p>If no input parameters are provided, such as DirectoryId or TrustIds, this request
POST/#X-Amz-Target=DirectoryService_20150416.DescribeUpdateDirectoryDescribes the updates of a directory for a particular update type.
POST/#X-Amz-Target=DirectoryService_20150416.DisableClientAuthenticationDisables alternative client authentication methods for the specified directory.
POST/#X-Amz-Target=DirectoryService_20150416.DisableLDAPSDeactivates LDAP secure calls for the specified directory.
POST/#X-Amz-Target=DirectoryService_20150416.DisableRadiusDisables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
POST/#X-Amz-Target=DirectoryService_20150416.DisableSsoDisables single-sign on for a directory.
POST/#X-Amz-Target=DirectoryService_20150416.EnableClientAuthenticationEnables alternative client authentication methods for the specified directory.
POST/#X-Amz-Target=DirectoryService_20150416.EnableLDAPSActivates the switch for the specific directory to always use LDAP secure calls.
POST/#X-Amz-Target=DirectoryService_20150416.EnableRadiusEnables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
POST/#X-Amz-Target=DirectoryService_20150416.EnableSsoEnables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to t
POST/#X-Amz-Target=DirectoryService_20150416.GetDirectoryLimitsObtains directory limit information for the current Region.
POST/#X-Amz-Target=DirectoryService_20150416.GetSnapshotLimitsObtains the manual snapshot limits for a directory.
POST/#X-Amz-Target=DirectoryService_20150416.ListCertificatesFor the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
POST/#X-Amz-Target=DirectoryService_20150416.ListIpRoutesLists the address blocks that you have added to a directory.
POST/#X-Amz-Target=DirectoryService_20150416.ListLogSubscriptionsLists the active log subscriptions for the Amazon Web Services account.
POST/#X-Amz-Target=DirectoryService_20150416.ListSchemaExtensionsLists all schema extensions applied to a Microsoft AD Directory.
POST/#X-Amz-Target=DirectoryService_20150416.ListTagsForResourceLists all tags on a directory.
POST/#X-Amz-Target=DirectoryService_20150416.RegisterCertificateRegisters a certificate for a secure LDAP or client certificate authentication.
POST/#X-Amz-Target=DirectoryService_20150416.RegisterEventTopicAssociates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email or
POST/#X-Amz-Target=DirectoryService_20150416.RejectSharedDirectoryRejects a directory sharing request that was sent from the directory owner account.
POST/#X-Amz-Target=DirectoryService_20150416.RemoveIpRoutesRemoves IP address blocks from a directory.
POST/#X-Amz-Target=DirectoryService_20150416.RemoveRegionStops all replication and removes the domain controllers from the specified Region. You cannot remove the primary Region with this operation. Instead, use the <
POST/#X-Amz-Target=DirectoryService_20150416.RemoveTagsFromResourceRemoves tags from a directory.
POST/#X-Amz-Target=DirectoryService_20150416.ResetUserPassword<p>Resets the password for any user in your Managed Microsoft AD or Simple AD directory.</p> <p>You can reset the password for any user in your directory with t
POST/#X-Amz-Target=DirectoryService_20150416.RestoreFromSnapshot<p>Restores a directory using an existing directory snapshot.</p> <p>When you restore a directory from a snapshot, any changes made to the directory after the s
POST/#X-Amz-Target=DirectoryService_20150416.ShareDirectory<p>Shares a specified directory (<code>DirectoryId</code>) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (direc
POST/#X-Amz-Target=DirectoryService_20150416.StartSchemaExtensionApplies a schema extension to a Microsoft AD directory.
POST/#X-Amz-Target=DirectoryService_20150416.UnshareDirectoryStops the directory sharing between the directory owner and consumer accounts.
POST/#X-Amz-Target=DirectoryService_20150416.UpdateConditionalForwarderUpdates a conditional forwarder that has been set up for your Amazon Web Services directory.
POST/#X-Amz-Target=DirectoryService_20150416.UpdateDirectorySetupUpdates the directory for a particular update type.
POST/#X-Amz-Target=DirectoryService_20150416.UpdateNumberOfDomainControllersAdds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domai
POST/#X-Amz-Target=DirectoryService_20150416.UpdateRadiusUpdates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
POST/#X-Amz-Target=DirectoryService_20150416.UpdateSettingsUpdates the configurable settings for the specified directory.
POST/#X-Amz-Target=DirectoryService_20150416.UpdateTrustUpdates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.
POST/#X-Amz-Target=DirectoryService_20150416.VerifyTrust<p>Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.</p> <p>This action verifies a trust relationship bet

Questions

Does the AWS Directory Service API need an API key?

Yes. The AWS Directory Service API uses API key authentication; the documentation explains how to get credentials.

Does the AWS Directory Service API support HTTPS?

Yes, the AWS Directory Service API is served over HTTPS.

How many endpoints does the AWS Directory Service API have?

Its OpenAPI description lists 67 endpoints in version 2015-04-16. All of them are shown on this page.

What are alternatives to the AWS Directory Service 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).