Skip to content

AWS Organizations API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<p>Organizations is a web service that enables you to consolidate your multiple Amazon Web Services accounts into an <i>organization</i> and centrally manage your accounts and their resources.</p> <p>This guide provides descriptions of the Organizations operations. For more information about using this service, see the <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">Organizations User Guide</a>.</p> <p> <b>Support and feedback for Organizations</b> </p> <p>We welcome your feedback. Send your comments to <a href="mailto:[email protected]">[email protected]</a> or post your feedback and questions in the <a href="http://forums.aws.amazon.com/forum.jspa?forumID=219">Organizations support forum</a>. For more information about the Amazon Web Services support forums, see <a href="http://forums.aws.amazon.com/help.jspa">Forums Help</a>.</p> <p> <b>Endpoint to call When using the CLI or the Amazon Web Services SDK</b> </p> <p>For the current release of Organizations, specify the <code>us-east-1</code> region for all Amazon Web Services API and CLI calls made from the commercial Amazon Web Services Regions outside of China. If calling from one of the Amazon Web Services Regions in China, then specify <code>cn-northwest-1</code>. You can do this in the CLI by using these parameters and commands:</p> <ul> <li> <p>Use the following parameter with each command to specify both the endpoint and its region:</p> <p> <code>--endpoint-url https://organizations.us-east-1.amazonaws.com</code> <i>(from commercial Amazon Web Services Regions outside of China)</i> </p> <p>or</p> <p> <code>--endpoint-url https://organizations.cn-northwest-1.amazonaws.com.cn</code> <i>(from Amazon Web Services Regions in China)</i> </p> </li> <li> <p>Use the default endpoint, but configure your default region with this command:</p> <p> <code>aws configure set default.region us-east-1</code> <i>(from commercial Amazon Web Services Regions outside of China)</i> </p> <p>or</p> <p> <code>aws configure set default.region cn-northwest-1</code> <i>(from Amazon Web Services Regions in China)</i> </p> </li> <li> <p>Use the following parameter with each command to specify the endpoint:</p> <p> <code>--region us-east-1</code> <i>(from commercial Amazon Web Services Regions outside of China)</i> </p> <p>or</p> <p> <code>--region cn-northwest-1</code> <i>(from Amazon Web Services Regions in China)</i> </p> </li> </ul> <p> <b>Recording API Requests</b> </p> <p>Organizations supports CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Organizations service received, who made the request and when, and so on. For more about Organizations and its support for CloudTrail, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_incident-response.html#orgs_cloudtrail-integration">Logging Organizations Events with CloudTrail</a> in the <i>Organizations User Guide</i>. To learn more about CloudTrail, including how to turn it on and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">CloudTrail User Guide</a>.</p>

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

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2016-11-28
Endpoints
55
Spec updated
2020-03-31

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=AWSOrganizationsV20161128.AcceptHandshake<p>Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.</p> <p>You can only call this operation by the fo
POST/#X-Amz-Target=AWSOrganizationsV20161128.AttachPolicy<p>Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy. Refer to t
POST/#X-Amz-Target=AWSOrganizationsV20161128.CancelHandshake<p>Cancels a handshake. Canceling a handshake sets the handshake state to <code>CANCELED</code>.</p> <p>This operation can be called only from the account that
POST/#X-Amz-Target=AWSOrganizationsV20161128.CloseAccount<p>Closes an Amazon Web Services member account within an organization. You can close an account when <a href="https://docs.aws.amazon.com/organizations/latest/
POST/#X-Amz-Target=AWSOrganizationsV20161128.CreateAccount<p>Creates an Amazon Web Services account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request
POST/#X-Amz-Target=AWSOrganizationsV20161128.CreateGovCloudAccount<p>This action is available if all of the following are true:</p> <ul> <li> <p>You're authorized to create accounts in the Amazon Web Services GovCloud (US) Reg
POST/#X-Amz-Target=AWSOrganizationsV20161128.CreateOrganization<p>Creates an Amazon Web Services organization. The account whose user is calling the <code>CreateOrganization</code> operation automatically becomes the <a hre
POST/#X-Amz-Target=AWSOrganizationsV20161128.CreateOrganizationalUnit<p>Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policie
POST/#X-Amz-Target=AWSOrganizationsV20161128.CreatePolicy<p>Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual Amazon Web Services account.</p> <p>For mor
POST/#X-Amz-Target=AWSOrganizationsV20161128.DeclineHandshake<p>Declines a handshake request. This sets the handshake state to <code>DECLINED</code> and effectively deactivates the request.</p> <p>This operation can be ca
POST/#X-Amz-Target=AWSOrganizationsV20161128.DeleteOrganizationDeletes the organization. You can delete an organization only by using credentials from the management account. The organization must be empty of member account
POST/#X-Amz-Target=AWSOrganizationsV20161128.DeleteOrganizationalUnit<p>Deletes an organizational unit (OU) from a root or another OU. You must first remove all accounts and child OUs from the OU that you want to delete.</p> <p>T
POST/#X-Amz-Target=AWSOrganizationsV20161128.DeletePolicy<p>Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all organizational units (OUs),
POST/#X-Amz-Target=AWSOrganizationsV20161128.DeleteResourcePolicy<p>Deletes the resource policy from your organization.</p> <p>You can only call this operation from the organization's management account.</p>
POST/#X-Amz-Target=AWSOrganizationsV20161128.DeregisterDelegatedAdministrator<p>Removes the specified member Amazon Web Services account as a delegated administrator for the specified Amazon Web Services service.</p> <important> <p>Dereg
POST/#X-Amz-Target=AWSOrganizationsV20161128.DescribeAccount<p>Retrieves Organizations-related information about the specified account.</p> <p>This operation can be called only from the organization's management account
POST/#X-Amz-Target=AWSOrganizationsV20161128.DescribeCreateAccountStatus<p>Retrieves the current status of an asynchronous request to create an account.</p> <p>This operation can be called only from the organization's management acc
POST/#X-Amz-Target=AWSOrganizationsV20161128.DescribeEffectivePolicy<p>Returns the contents of the effective policy for specified policy type and account. The effective policy is the aggregation of any policies of the specified
POST/#X-Amz-Target=AWSOrganizationsV20161128.DescribeHandshake<p>Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original <a>InviteAccountToOrganization</a> ope
POST/#X-Amz-Target=AWSOrganizationsV20161128.DescribeOrganization<p>Retrieves information about the organization that the user's account belongs to.</p> <p>This operation can be called from any account in the organization.</p
POST/#X-Amz-Target=AWSOrganizationsV20161128.DescribeOrganizationalUnit<p>Retrieves information about an organizational unit (OU).</p> <p>This operation can be called only from the organization's management account or by a member a
POST/#X-Amz-Target=AWSOrganizationsV20161128.DescribePolicy<p>Retrieves information about a policy.</p> <p>This operation can be called only from the organization's management account or by a member account that is a de
POST/#X-Amz-Target=AWSOrganizationsV20161128.DescribeResourcePolicy<p>Retrieves information about a resource policy.</p> <p>You can only call this operation from the organization's management account or by a member account that
POST/#X-Amz-Target=AWSOrganizationsV20161128.DetachPolicy<p>Detaches a policy from a target root, organizational unit (OU), or account.</p> <important> <p>If the policy being detached is a service control policy (SCP)
POST/#X-Amz-Target=AWSOrganizationsV20161128.DisableAWSServiceAccess<p>Disables the integration of an Amazon Web Services service (the service that is specified by <code>ServicePrincipal</code>) with Organizations. When you disa
POST/#X-Amz-Target=AWSOrganizationsV20161128.DisablePolicyType<p>Disables an organizational policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root.
POST/#X-Amz-Target=AWSOrganizationsV20161128.EnableAWSServiceAccess<p>Enables the integration of an Amazon Web Services service (the service that is specified by <code>ServicePrincipal</code>) with Organizations. When you enabl
POST/#X-Amz-Target=AWSOrganizationsV20161128.EnableAllFeatures<p>Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each
POST/#X-Amz-Target=AWSOrganizationsV20161128.EnablePolicyType<p>Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or
POST/#X-Amz-Target=AWSOrganizationsV20161128.InviteAccountToOrganization<p>Sends an invitation to another account to join your organization as a member account. Organizations sends email on your behalf to the email address that is a
POST/#X-Amz-Target=AWSOrganizationsV20161128.LeaveOrganization<p>Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member acco
POST/#X-Amz-Target=AWSOrganizationsV20161128.ListAWSServiceAccessForOrganization<p>Returns a list of the Amazon Web Services services that you enabled to integrate with your organization. After a service on this list creates the resources t
POST/#X-Amz-Target=AWSOrganizationsV20161128.ListAccounts<p>Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the <a>ListAccountsForParent</a
POST/#X-Amz-Target=AWSOrganizationsV20161128.ListAccountsForParent<p>Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of
POST/#X-Amz-Target=AWSOrganizationsV20161128.ListChildren<p>Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with <a>ListParents</a>
POST/#X-Amz-Target=AWSOrganizationsV20161128.ListCreateAccountStatus<p>Lists the account creation requests that match the specified status that is currently being tracked for the organization.</p> <note> <p>Always check the <cod
POST/#X-Amz-Target=AWSOrganizationsV20161128.ListDelegatedAdministrators<p>Lists the Amazon Web Services accounts that are designated as delegated administrators in this organization.</p> <p>This operation can be called only from th
POST/#X-Amz-Target=AWSOrganizationsV20161128.ListDelegatedServicesForAccount<p>List the Amazon Web Services services for which the specified account is a delegated administrator.</p> <p>This operation can be called only from the organiz
POST/#X-Amz-Target=AWSOrganizationsV20161128.ListHandshakesForAccount<p>Lists the current handshakes that are associated with the account of the requesting user.</p> <p>Handshakes that are <code>ACCEPTED</code>, <code>DECLINED</c
POST/#X-Amz-Target=AWSOrganizationsV20161128.ListHandshakesForOrganization<p>Lists the handshakes that are associated with the organization that the requesting user is part of. The <code>ListHandshakesForOrganization</code> operation
POST/#X-Amz-Target=AWSOrganizationsV20161128.ListOrganizationalUnitsForParent<p>Lists the organizational units (OUs) in a parent organizational unit or root.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a
POST/#X-Amz-Target=AWSOrganizationsV20161128.ListParents<p>Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with <a>ListChild
POST/#X-Amz-Target=AWSOrganizationsV20161128.ListPolicies<p>Retrieves the list of all policies in an organization of a specified type.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <co
POST/#X-Amz-Target=AWSOrganizationsV20161128.ListPoliciesForTarget<p>Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you w
POST/#X-Amz-Target=AWSOrganizationsV20161128.ListRoots<p>Lists the roots that are defined in the current organization.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code
POST/#X-Amz-Target=AWSOrganizationsV20161128.ListTagsForResource<p>Lists tags that are attached to the specified resource.</p> <p>You can attach tags to the following resources in Organizations.</p> <ul> <li> <p>Amazon Web S
POST/#X-Amz-Target=AWSOrganizationsV20161128.ListTargetsForPolicy<p>Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.</p> <note> <p>Always check the <code>NextToken</code>
POST/#X-Amz-Target=AWSOrganizationsV20161128.MoveAccount<p>Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU.</p> <p>This operation can be
POST/#X-Amz-Target=AWSOrganizationsV20161128.PutResourcePolicy<p>Creates or updates a resource policy.</p> <p>You can only call this operation from the organization's management account.</p>
POST/#X-Amz-Target=AWSOrganizationsV20161128.RegisterDelegatedAdministrator<p>Enables the specified member account to administer the Organizations features of the specified Amazon Web Services service. It grants read-only access to Org
POST/#X-Amz-Target=AWSOrganizationsV20161128.RemoveAccountFromOrganization<p>Removes the specified account from the organization.</p> <p>The removed account becomes a standalone account that isn't a member of any organization. It's no
POST/#X-Amz-Target=AWSOrganizationsV20161128.TagResource<p>Adds one or more tags to the specified resource.</p> <p>Currently, you can attach tags to the following resources in Organizations.</p> <ul> <li> <p>Amazon W
POST/#X-Amz-Target=AWSOrganizationsV20161128.UntagResource<p>Removes any tags with the specified keys from the specified resource.</p> <p>You can attach tags to the following resources in Organizations.</p> <ul> <li> <
POST/#X-Amz-Target=AWSOrganizationsV20161128.UpdateOrganizationalUnit<p>Renames the specified organizational unit (OU). The ID and ARN don't change. The child OUs and accounts remain in place, and any attached policies of the OU
POST/#X-Amz-Target=AWSOrganizationsV20161128.UpdatePolicy<p>Updates an existing policy with a new name, description, or content. If you don't supply any parameter, that value remains unchanged. You can't change a poli

Questions

Does the AWS Organizations API need an API key?

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

Does the AWS Organizations API support HTTPS?

Yes, the AWS Organizations API is served over HTTPS.

How many endpoints does the AWS Organizations API have?

Its OpenAPI description lists 55 endpoints in version 2016-11-28. All of them are shown on this page.

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