Amazon Web Services, Inc.

AWS Organizations

Organizations is a web service that enables you to consolidate your multiple Amazon Web Services accounts into an organization and centrally manage your…

Developer tools#openapi#cloud

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

Organizations is a web service that enables you to consolidate your multiple
Amazon Web Services accounts into an organization and centrally manage your
accounts and their resources.
This guide provides descriptions of the Organizations API. For more
information about using this service, see the Organizations User Guide .

API version

This version of the Organizations API Reference documents the Organizations API version
2016-11-28.

As an alternative to using the API directly, you can use one of the Amazon Web Services SDKs,
which consist of libraries and sample code for various programming languages and
platforms (Java, Ruby, .NET, iOS, Android, and more). The SDKs provide a convenient
way to create programmatic access to Organizations. For example, the SDKs take care of
cryptographically signing requests, managing errors, and retrying requests
automatically. For more information about the Amazon Web Services SDKs, including how to download
and install them, see Tools for Amazon Web
Services .

We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to Organizations.
However, you also can use the Organizations Query API to make direct calls to the Organizations web
service. To learn more about the Organizations Query API, see Calling the API by making HTTP Query
requests in the Organizations User Guide . Organizations supports GET and
POST requests for all actions. That is, the API doesn't require you to use GET for some
actions and POST for others. However, GET requests are subject to the limitation size of
a URL. Therefore, for operations that require larger sizes, use a POST request.

Signing requests

When you send HTTP requests to Amazon Web Services, sign the requests so that Amazon Web Services can identify
who sent them. You sign requests with your Amazon Web Services access key, which consists of an access
key ID and a secret access key. We strongly recommend that you don't create an access
key for your root account. Anyone who has the access key for your root account has
unrestricted access to all the resources in your account. Instead, create an access key
for an IAM user that has administrative permissions. As another option, use Amazon Web Services
Security Token Service (Amazon Web Services STS) to generate temporary security credentials, and use
those credentials to sign requests.
To sign requests, we recommend that you use Signature Version 4 . If you
have an existing application that uses Signature Version 2, you don't have to update it
to use Signature Version 4. However, some operations now require Signature Version 4.
The documentation for operations that require version 4 indicate this
requirement.
When you use the Command Line Interface (CLI) or one of the Amazon Web Services SDKs to make requests to
Amazon Web Services, these tools automatically sign the requests for you with the access key that you
specify when you configure the tools.
In this release, each organization can have only one root.

Support and feedback for Organizations

We welcome your feedback. You can post your feedback and questions in the Organizations support
forum . For more information about the Amazon Web Services Support forums, see Forums Help .

Endpoint to call When using the CLI or the Amazon Web Services
SDK

For the current release of Organizations, specify the us-east-1 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
cn-northwest-1 . You can do this in the CLI by using these parameters
and commands:

Use the following parameter with each command to specify both the endpoint and
its region:

--endpoint-url https://organizations.us-east-1.amazonaws.com
(from commercial Amazon Web Services Regions outside of China)

or

--endpoint-url
https://organizations.cn-northwest-1.amazonaws.com.cn
(from Amazon Web Services Regions in China)

Use the default endpoint, but configure your default region with this
command:

aws configure set default.region us-east-1
(from…

Endpoints 63

  • POSTAccept handshake/#X-Amz-Target=AWSOrganizationsV20161128.AcceptHandshakeAccepts a handshake by sending an ACCEPTED response to the sender. You can view accepted handshakes in API responses for 30 days before they are deleted. Only…
  • POSTAttach policy/#X-Amz-Target=AWSOrganizationsV20161128.AttachPolicyAttaches 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…
  • POSTCancel handshake/#X-Amz-Target=AWSOrganizationsV20161128.CancelHandshakeCancels a Handshake . Only the account that sent a handshake can call this operation. The recipient of the handshake can't cancel it, but can use…
  • POSTClose account/#X-Amz-Target=AWSOrganizationsV20161128.CloseAccountCloses an Amazon Web Services member account within an organization. You can close an account when all features are enabled . You can't close the management…
  • POSTCreate account/#X-Amz-Target=AWSOrganizationsV20161128.CreateAccountCreates an Amazon Web Services account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request…
  • POSTCreate gov cloud account/#X-Amz-Target=AWSOrganizationsV20161128.CreateGovCloudAccountThis action is available if all of the following are true: You're authorized to create accounts in the Amazon Web Services GovCloud (US) Region. For more…
  • POSTCreate organization/#X-Amz-Target=AWSOrganizationsV20161128.CreateOrganizationCreates an Amazon Web Services organization. The account whose user is calling the CreateOrganization operation automatically becomes the management account…
  • POSTCreate organizational unit/#X-Amz-Target=AWSOrganizationsV20161128.CreateOrganizationalUnitCreates 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 policies…
  • POSTCreate policy/#X-Amz-Target=AWSOrganizationsV20161128.CreatePolicyCreates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual Amazon Web Services account. For more…
  • POSTDecline handshake/#X-Amz-Target=AWSOrganizationsV20161128.DeclineHandshakeDeclines a Handshake . Only the account that receives a handshake can call this operation. The sender of the handshake can use CancelHandshake to cancel if…
  • POSTDelete organization/#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…
  • POSTDelete organizational unit/#X-Amz-Target=AWSOrganizationsV20161128.DeleteOrganizationalUnitDeletes 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. You can…
  • POSTDelete policy/#X-Amz-Target=AWSOrganizationsV20161128.DeletePolicyDeletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all organizational units (OUs),…
  • POSTDelete resource policy/#X-Amz-Target=AWSOrganizationsV20161128.DeleteResourcePolicyDeletes the resource policy from your organization. You can only call this operation from the management account.
  • POSTDeregister delegated administrator/#X-Amz-Target=AWSOrganizationsV20161128.DeregisterDelegatedAdministratorRemoves the specified member Amazon Web Services account as a delegated administrator for the specified Amazon Web Services service. Deregistering a delegated…
  • POSTDescribe account/#X-Amz-Target=AWSOrganizationsV20161128.DescribeAccountRetrieves Organizations-related information about the specified account. You can only call this operation from the management account or a member account that…
  • POSTDescribe create account status/#X-Amz-Target=AWSOrganizationsV20161128.DescribeCreateAccountStatusRetrieves the current status of an asynchronous request to create an account. You can only call this operation from the management account or a member account…
  • POSTDescribe effective policy/#X-Amz-Target=AWSOrganizationsV20161128.DescribeEffectivePolicyReturns the contents of the effective policy for specified policy type and account. The effective policy is the aggregation of any policies of the specified…
  • POSTDescribe handshake/#X-Amz-Target=AWSOrganizationsV20161128.DescribeHandshakeReturns details for a handshake. A handshake is the secure exchange of information between two Amazon Web Services accounts: a sender and a recipient. You can…
  • POSTDescribe organization/#X-Amz-Target=AWSOrganizationsV20161128.DescribeOrganizationRetrieves information about the organization that the user's account belongs to. You can call this operation from any account in a organization. Even if a…
  • POSTDescribe organizational unit/#X-Amz-Target=AWSOrganizationsV20161128.DescribeOrganizationalUnitRetrieves information about an organizational unit (OU). You can only call this operation from the management account or a member account that is a delegated…
  • POSTDescribe policy/#X-Amz-Target=AWSOrganizationsV20161128.DescribePolicyRetrieves information about a policy. You can only call this operation from the management account or a member account that is a delegated administrator.
  • POSTDescribe resource policy/#X-Amz-Target=AWSOrganizationsV20161128.DescribeResourcePolicyRetrieves information about a resource policy. You can only call this operation from the management account or a member account that is a delegated…
  • POSTDescribe responsibility transfer/#X-Amz-Target=AWSOrganizationsV20161128.DescribeResponsibilityTransferReturns details for a transfer. A transfer is an arrangement between two management accounts where one account designates the other with specified…
  • POSTDetach policy/#X-Amz-Target=AWSOrganizationsV20161128.DetachPolicyDetaches a policy from a target root, organizational unit (OU), or account. If the policy being detached is a service control policy (SCP), the changes to…
  • POSTDisable aWS service access/#X-Amz-Target=AWSOrganizationsV20161128.DisableAWSServiceAccessDisables the integration of an Amazon Web Services service (the service that is specified by ServicePrincipal ) with Organizations. When you disable…
  • POSTDisable policy type/#X-Amz-Target=AWSOrganizationsV20161128.DisablePolicyTypeDisables 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.…
  • POSTEnable aWS service access/#X-Amz-Target=AWSOrganizationsV20161128.EnableAWSServiceAccessProvides an Amazon Web Services service (the service that is specified by ServicePrincipal ) with permissions to view the structure of an organization, create…
  • POSTEnable all features/#X-Amz-Target=AWSOrganizationsV20161128.EnableAllFeaturesEnables 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…
  • POSTEnable policy type/#X-Amz-Target=AWSOrganizationsV20161128.EnablePolicyTypeEnables 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…
  • POSTInvite account to organization/#X-Amz-Target=AWSOrganizationsV20161128.InviteAccountToOrganizationSends 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…
  • POSTInvite organization to transfer responsibility/#X-Amz-Target=AWSOrganizationsV20161128.InviteOrganizationToTransferResponsibilitySends an invitation to another organization's management account to designate your account with the specified responsibilities for their organization. The…
  • POSTLeave organization/#X-Amz-Target=AWSOrganizationsV20161128.LeaveOrganizationRemoves 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…
  • POSTList aWS service access for organization/#X-Amz-Target=AWSOrganizationsV20161128.ListAWSServiceAccessForOrganizationReturns 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…
  • POSTList accounts/#X-Amz-Target=AWSOrganizationsV20161128.ListAccountsLists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the ListAccountsForParent…
  • POSTList accounts for parent/#X-Amz-Target=AWSOrganizationsV20161128.ListAccountsForParentLists 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…
  • POSTList accounts with invalid effective policy/#X-Amz-Target=AWSOrganizationsV20161128.ListAccountsWithInvalidEffectivePolicyLists all the accounts in an organization that have invalid effective policies. An invalid effective policy is an effective policy that fails validation…
  • POSTList children/#X-Amz-Target=AWSOrganizationsV20161128.ListChildrenLists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with ListParents enables…
  • POSTList create account status/#X-Amz-Target=AWSOrganizationsV20161128.ListCreateAccountStatusLists the account creation requests that match the specified status that is currently being tracked for the organization. When calling List* operations,…
  • POSTList delegated administrators/#X-Amz-Target=AWSOrganizationsV20161128.ListDelegatedAdministratorsLists the Amazon Web Services accounts that are designated as delegated administrators in this organization. You can only call this operation from the…
  • POSTList delegated services for account/#X-Amz-Target=AWSOrganizationsV20161128.ListDelegatedServicesForAccountList the Amazon Web Services services for which the specified account is a delegated administrator. You can only call this operation from the management…
  • POSTList effective policy validation errors/#X-Amz-Target=AWSOrganizationsV20161128.ListEffectivePolicyValidationErrorsLists all the validation errors on an effective policy for a specified account and policy type. You can only call this operation from the management account…
  • POSTList handshakes for account/#X-Amz-Target=AWSOrganizationsV20161128.ListHandshakesForAccountLists the recent handshakes that you have received. You can view CANCELED , ACCEPTED , DECLINED , or EXPIRED handshakes in API responses for 30 days before…
  • POSTList handshakes for organization/#X-Amz-Target=AWSOrganizationsV20161128.ListHandshakesForOrganizationLists the recent handshakes that you have sent. You can view CANCELED , ACCEPTED , DECLINED , or EXPIRED handshakes in API responses for 30 days before they…
  • POSTList inbound responsibility transfers/#X-Amz-Target=AWSOrganizationsV20161128.ListInboundResponsibilityTransfersLists transfers that allow you to manage the specified responsibilities for another organization. This operation returns both transfer invitations and…
  • POSTList organizational units for parent/#X-Amz-Target=AWSOrganizationsV20161128.ListOrganizationalUnitsForParentLists the organizational units (OUs) in a parent organizational unit or root. When calling List* operations, always check the NextToken response parameter…
  • POSTList outbound responsibility transfers/#X-Amz-Target=AWSOrganizationsV20161128.ListOutboundResponsibilityTransfersLists transfers that allow an account outside your organization to manage the specified responsibilities for your organization. This operation returns both…
  • POSTList parents/#X-Amz-Target=AWSOrganizationsV20161128.ListParentsLists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with ListChildren…
  • POSTList policies/#X-Amz-Target=AWSOrganizationsV20161128.ListPoliciesRetrieves the list of all policies in an organization of a specified type. When calling List* operations, always check the NextToken response parameter value,…
  • POSTList policies for target/#X-Amz-Target=AWSOrganizationsV20161128.ListPoliciesForTargetLists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you…
  • POSTList roots/#X-Amz-Target=AWSOrganizationsV20161128.ListRootsLists the roots that are defined in the current organization. When calling List* operations, always check the NextToken response parameter value, even if you…
  • POSTList tags for resource/#X-Amz-Target=AWSOrganizationsV20161128.ListTagsForResourceLists tags that are attached to the specified resource. You can attach tags to the following resources in Organizations. Amazon Web Services account…
  • POSTList targets for policy/#X-Amz-Target=AWSOrganizationsV20161128.ListTargetsForPolicyLists all the roots, organizational units (OUs), and accounts that the specified policy is attached to. When calling List* operations, always check the…
  • POSTMove account/#X-Amz-Target=AWSOrganizationsV20161128.MoveAccountMoves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU. You can only call this…
  • POSTPut resource policy/#X-Amz-Target=AWSOrganizationsV20161128.PutResourcePolicyCreates or updates a resource policy. You can only call this operation from the management account..
  • POSTRegister delegated administrator/#X-Amz-Target=AWSOrganizationsV20161128.RegisterDelegatedAdministratorEnables the specified member account to administer the Organizations features of the specified Amazon Web Services service. It grants read-only access to…
  • POSTRemove account from organization/#X-Amz-Target=AWSOrganizationsV20161128.RemoveAccountFromOrganizationRemoves the specified account from the organization. The removed account becomes a standalone account that isn't a member of any organization. It's no longer…
  • POSTTag resource/#X-Amz-Target=AWSOrganizationsV20161128.TagResourceAdds one or more tags to the specified resource. Currently, you can attach tags to the following resources in Organizations. Amazon Web Services account…
  • POSTTerminate responsibility transfer/#X-Amz-Target=AWSOrganizationsV20161128.TerminateResponsibilityTransferEnds a transfer. A transfer is an arrangement between two management accounts where one account designates the other with specified responsibilities for their…
  • POSTUntag resource/#X-Amz-Target=AWSOrganizationsV20161128.UntagResourceRemoves any tags with the specified keys from the specified resource. You can attach tags to the following resources in Organizations. Amazon Web Services…
  • POSTUpdate organizational unit/#X-Amz-Target=AWSOrganizationsV20161128.UpdateOrganizationalUnitRenames 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…
  • POSTUpdate policy/#X-Amz-Target=AWSOrganizationsV20161128.UpdatePolicyUpdates 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…
  • POSTUpdate responsibility transfer/#X-Amz-Target=AWSOrganizationsV20161128.UpdateResponsibilityTransferUpdates a transfer. A transfer is the arrangement between two management accounts where one account designates the other with specified responsibilities for…

API details

Base URL
https://organizations.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
63 operations on 63 pathsPOST 63
Description format
AWS Smithy model, API version 2016-11-28

How to test the AWS Organizations 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 Organizations 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 “Accept handshake” (POST /#X-Amz-Target=AWSOrganizationsV20161128.AcceptHandshake), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Organizations?

Organizations is a web service that enables you to consolidate your multiple Amazon Web Services accounts into an organization and centrally manage your… It is listed under Developer tools and has 63 endpoints.

Who publishes the AWS Organizations?

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 Organizations?

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

How do I authenticate with the AWS Organizations?

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

How many endpoints does the AWS Organizations have?

63 operations on 63 paths (63 POST).

Is forking the AWS Organizations 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.