Amazon Web Services, Inc.

AWS Directory Service Data

Amazon Web Services Directory Service Data is an extension of Directory Service. This API reference provides detailed information about Directory Service Data…

Data & analytics#openapi

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

Amazon Web Services Directory Service Data is an extension of Directory Service. This API reference provides detailed information
about Directory Service Data operations and object types.
With Directory Service Data, you can create, read, update, and delete users, groups, and memberships from
your Managed Microsoft AD without additional costs and without deploying dedicated management
instances. You can also perform built-in object management tasks across directories without
direct network connectivity, which simplifies provisioning and access management to achieve
fully automated deployments. Directory Service Data supports user and group write operations, such as
CreateUser and CreateGroup , within the organizational unit (OU) of
your Managed Microsoft AD. Directory Service Data supports read operations, such as ListUsers and
ListGroups , on all users, groups, and group memberships within your
Managed Microsoft AD and across trusted realms. Directory Service Data supports adding and removing group members in
your OU and the Amazon Web Services Delegated Groups OU, so you can grant and deny access to specific roles
and permissions. For more information, see Manage users and
groups in the Directory Service Administration Guide .

Directory management operations and configuration changes made against the Directory Service
API will also reflect in Directory Service Data API with eventual consistency. You can expect a short delay
between management changes, such as adding a new directory trust and calling the Directory Service Data API
for the newly created trusted realm.

Directory Service Data connects to your Managed Microsoft AD domain controllers and performs operations on
underlying directory objects. When you create your Managed Microsoft AD, you choose subnets for domain
controllers that Directory Service creates on your behalf. If a domain controller is unavailable, Directory Service Data
uses an available domain controller. As a result, you might notice eventual consistency while
objects replicate from one domain controller to another domain controller. For more
information, see What
gets created in the Directory Service Administration Guide .
Directory limits vary by Managed Microsoft AD edition:

Standard edition – Supports 8 transactions per
second (TPS) for read operations and 4 TPS for write operations per directory. There's a
concurrency limit of 10 concurrent requests.

Enterprise edition – Supports 16 transactions per
second (TPS) for read operations and 8 TPS for write operations per directory. There's a
concurrency limit of 10 concurrent requests.

Amazon Web Services Account - Supports a total of 100 TPS for
Directory Service Data operations across all directories.

Directory Service Data only supports the Managed Microsoft AD directory type and is only available in the primary
Amazon Web Services Region. For more information, see Managed Microsoft AD
and Primary vs additional Regions in the Directory Service Administration
Guide .

Endpoints 17

  • POSTAdd group member/GroupMemberships/AddGroupMember?DirectoryId=stringAdds an existing user, group, or computer as a group member.
  • POSTCreate group/Groups/CreateGroup?DirectoryId=stringCreates a new group.
  • POSTCreate user/Users/CreateUser?DirectoryId=stringCreates a new user.
  • POSTDelete group/Groups/DeleteGroup?DirectoryId=stringDeletes a group.
  • POSTDelete user/Users/DeleteUser?DirectoryId=stringDeletes a user.
  • POSTDescribe group/Groups/DescribeGroup?DirectoryId=stringReturns information about a specific group.
  • POSTDescribe user/Users/DescribeUser?DirectoryId=stringReturns information about a specific user.
  • POSTDisable user/Users/DisableUser?DirectoryId=stringDeactivates an active user account. For information about how to enable an inactive user account, see ResetUserPassword in the Directory Service API Reference .
  • POSTList group members/GroupMemberships/ListGroupMembers?DirectoryId=stringReturns member information for the specified group. This operation supports pagination with the use of the NextToken request and response parameters. If more…
  • POSTList groups/Groups/ListGroups?DirectoryId=stringReturns group information for the specified directory. This operation supports pagination with the use of the NextToken request and response parameters. If…
  • POSTList groups for member/GroupMemberships/ListGroupsForMember?DirectoryId=stringReturns group information for the specified member. This operation supports pagination with the use of the NextToken request and response parameters. If more…
  • POSTList users/Users/ListUsers?DirectoryId=stringReturns user information for the specified directory. This operation supports pagination with the use of the NextToken request and response parameters. If…
  • POSTRemove group member/GroupMemberships/RemoveGroupMember?DirectoryId=stringRemoves a member from a group.
  • POSTSearch groups/Groups/SearchGroups?DirectoryId=stringSearches the specified directory for a group. You can find groups that match the SearchString parameter with the value of their attributes included in the…
  • POSTSearch users/Users/SearchUsers?DirectoryId=stringSearches the specified directory for a user. You can find users that match the SearchString parameter with the value of their attributes included in the…
  • POSTUpdate group/Groups/UpdateGroup?DirectoryId=stringUpdates group information.
  • POSTUpdate user/Users/UpdateUser?DirectoryId=stringUpdates user information.

API details

Base URL
https://ds-data.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
17 operations on 17 pathsPOST 17
Description format
AWS Smithy model, API version 2023-05-31

How to test the AWS Directory Service Data in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Directory Service Data collection, without the publisher's secrets.
  3. 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.
  4. Send a requestPick an endpoint, for example “Add group member” (POST /GroupMemberships/AddGroupMember?DirectoryId=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Directory Service Data?

Amazon Web Services Directory Service Data is an extension of Directory Service. This API reference provides detailed information about Directory Service Data… It is listed under Data & analytics and has 17 endpoints.

Who publishes the AWS Directory Service Data?

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 AWS Directory Service Data?

Requests go to https://ds-data.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Directory Service Data?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Directory Service Data have?

17 operations on 17 paths (17 POST).

Is forking the AWS Directory Service Data free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.